Get Cache Settings
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/caches
Returns cache settings of the specified database.
Request
-
applicationName(required): string
Application name.
-
databaseName(required): string
Database name.
Response
- application/json
- application/xml
200 Response
OK
Cache settings returned successfully.
object
-
cacheMemoryLocking:
boolean
Deprecated, along with direct I/O
-
dataCacheCurrentValue:
integer(int64)
The run-time size (in KB) of the data cache
-
dataCacheSetting:
integer(int64)
The data cache size setting value (in KB) currently in effect
-
dataFileCacheCurrentValue:
integer(int64)
The run-time data file cache size (in KB) currently in use by the cube. Once you have changed the data file cache size, you must stop and restart the cube in order for the new data file cache size to take effect.
-
dataFileCacheSetting:
integer(int64)
The data file cache size setting value currently in effect
-
indexCacheCurrentValue:
integer(int64)
Run-time size (in KB) of the index cache
-
indexCacheSetting:
integer(int64)
The index cache size (in KB) setting value currently in effect
-
indexPageCurrentValue:
integer(int32)
Run-time size (in KB) of an index page
-
indexPageSetting:
integer(int32)
The index page size setting (in KB) currently in effect
400 Response
Bad Request
Failed to get the cache settings. The application or database name may be incorrect.
500 Response
Internal Server Error.
Examples
The following example shows how to get cache settings for a cube.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat
.
Script with cURL Command
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/caches" -H "accept: application/json" -u %User%:%Password%
Example of Response Body
{
"caches": {
"cacheMemoryLocking": false,
"indexCacheSetting": 1048576,
"indexCacheCurrentValue": 1048576,
"dataFileCacheSetting": 33554432,
"dataFileCacheCurrentValue": 0,
"dataCacheSetting": 3145728,
"dataCacheCurrentValue": 0,
"indexPageSetting": 8192,
"indexPageCurrentValue": 8192
}
}