MicroStrategy REST API API Documentation
Get the aggregated cube cache capacity usage info which groups by project or user
GET {{baseUrl}}/api/monitors/caches/cubes/aggregatedUsages?clusterNode={{clusterNodeName}}
Get the aggregated cube cache capacity usage info which groups by project or user. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header.
Body
PARAM
| Key | Datatype | Required | Description |
clusterNode
|
string | (Required) Intelligence Server cluster node name | |
aggregateBy
|
string | An enum to control the cache usage aggregated by which object, currently just support aggregated by project or user | |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token |
RESPONSES
status OK
| {
"aggregatedCacheUsages": [
{
"id": "B7CA92F04B9FAE8D941C3E9B7E0CD754",
"name": "MicroStrategy Tutorial",
"currentUsage": 945960960,
"capacity": 3349006336
},
{
"id": "CE52831411E696C8BD2F0080EFD5AF44",
"name": "Consolidated Education Project",
"currentUsage": 0,
"capacity": 268435456
}
]
} |
Curl
curl -X GET 'baseUrl/api/monitors/caches/cubes/aggregatedUsages?clusterNode=clusterNodeName?clusterNode=clusterNodeName&aggregateBy=project&fields=' -H 'X-MSTR-AuthToken: authToken'
ENDPOINTS