Qodex.ai

Get the list of cube caches on an specific cluster node

GET {{baseUrl}}/api/monitors/caches/cubes?clusterNode={{clusterNodeName}}

Get the list of cube caches.You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You can specify sorting criteria on fields: name, size, hitCount, lastUpdateTime, status, project, owner, you can also filter response data by projectId or status, you can set the offset and limit for pagination function, and provide the clusterNode, you will retrieve the cube caches infos

Request Params

KeyDatatypeRequiredDescription
clusterNodestring(Required) Intelligence Server cluster node name
offsetnumberStarting point within the collection of returned results. Used to control paging behavior.
limitnumberMaximum number of items returned for a single request. Used to control paging behavior. Use -1 for no limit.
projectIdsstringProject id collection which is used for filtering data, for example 'B19DEDCC11D4E0EFC000EB9495D0F6E2,A232EDCC11D4E0EFC000EB9495D0F6E2'
Cube Object IDsnullCube definition object id collection which is used for filtering data, for example 'B19DEDCC11D4E0EFC000EB9495D0F6E2,A232EDCC11D4E0EFC000EB9495D0F6E2'
state.loadedStatestringloaded state filter field which is used for filtering loaded cube cache, valid input: 'loaded'
sortBynullspecify sorting criteria, for example '+name,-size' means sorting name ascending and size descending
fieldsnullComma-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

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization token

RESPONSES

status: OK

{"offset":0,"limit":2,"total":192,"loaded":103,"unloaded":89,"cubeCaches":[{"id":"Mjc3RUQ1ODc0NDg5MjE5MDQ1M0VCNTgxRUFDNkI4QkY6QjdDQTkyRjA0QjlGQUU4RDk0MUMzRTlCN0UwQ0Q3NTQ6ZW52LTI3NjY4NmxhaW91c2Ux","projectId":"B7CA92F04B9FAE8D941C3E9B7E0CD754","source":{"name":"2013 Webcast Metrics#6_20140306142013","id":"E0C504BC4954D594C2332CB8B421D906","type":"cube"},"state":{"active":true,"dirty":false,"infoDirty":false,"persisted":true,"processing":false,"loadedState":"unloaded"},"lastUpdateTime":"2016-08-03T19:17:49.000+0000","lastHitTime":"2017-02-06T23:12:16.000+0000","hitCount":0,"size":688128,"creatorName":"Administrator","creatorId":"54F3D26011D2896560009A8E67019608","lastUpdateJob":279671,"openViewCount":0,"creationTime":"2014-05-22T16:20:01.000+0000","historicHitCount":22,"fileName":"/opt/mstr/MicroStrategy/IntelligenceServer/Cube/cloud_10s/Server_env-276686laiouse1_PB7CA92F04B9FAE8D941C3E9B7E0CD754/277ED58744892190453EB581EAC6B8BF.cube","dataLanguages":[],"rowCount":0,"columnCount":0,"cubeType":"in_memory"},{"id":"QUVEMEQ2ODgxMUU3NzIxMTFDRDkwMDgwRUZFNThCRkM6QjdDQTkyRjA0QjlGQUU4RDk0MUMzRTlCN0UwQ0Q3NTQ6ZW52LTI3NjY4NmxhaW91c2Ux","projectId":"B7CA92F04B9FAE8D941C3E9B7E0CD754","source":{"name":"2013 Webcast Metrics#6_20140306142013","id":"ADA1BBA611E772111D000080EFE58BFC","type":"cube"},"state":{"active":true,"dirty":false,"infoDirty":false,"persisted":true,"processing":false,"loadedState":"loaded"},"lastUpdateTime":"2017-07-26T14:49:53.000+0000","lastHitTime":"2022-03-02T21:08:44.000+0000","hitCount":0,"size":1484800,"creatorName":"Administrator","creatorId":"54F3D26011D2896560009A8E67019608","lastUpdateJob":279671,"openViewCount":1,"creationTime":"2014-05-22T16:20:01.000+0000","historicHitCount":24,"fileName":"/opt/mstr/MicroStrategy/IntelligenceServer/Cube/cloud_10s/Server_env-276686laiouse1_PB7CA92F04B9FAE8D941C3E9B7E0CD754/AED0D68811E772111CD90080EFE58BFC.cube","dataLanguages":[],"rowCount":0,"columnCount":0,"cubeType":"in_memory"}]}