Get file storage system statistics
Retrieves system statistics data for file storage.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/statistics/{systemStatsType}
Parameters
Name | Type | Required | Values | Description |
systemStatsType | URI_PARAM | Y | string | It can be either an arbitrary filter string or the following pre-defined type of statistics data to retrieve. In case of an arbitrary string, certain restrictions such as minimum length and excluding some special characters will apply(see example). Possible pre-defined values are:
|
Return codes
Code | Data | Description |
200 | storageStatistics | A storageStatistics object is retrieved successfully. |
400 | Error Message | Missing or invalid request contents. |
404 | Error Message | Requested resource not found. |
500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 200 indicates that the API did not complete successfully.
Request example using a pre-defined search string
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.239.120:8444/v8/storage/statistics/HEAP_USAGE
Response example using a pre-defined search string
HTTP/1.1 200 OK { "storageStatistics": [ { "name": "Heap Usage (%)", "nodeUUID": "328511ce-680f-11d1-9001-040400070206", "value": 62 }, { "name": "Heap Usage (%)", "nodeUUID": "31533498-680f-11d1-9001-8188be748157", "value": 62 } ] }
Request example using an arbitrary search string “111”
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.239.120:8444/v8/storage/statistics/111
Response example using an arbitrary search string "111"
HTTP/1.1 200 OK { "storageStatistics": [ { "name": "LongTermSizeBasedPool-4398046511120: pool current", "nodeUUID": "dc1da44a-f532-11d4-9001-11b384af0bfe", "value": 0 }, { "name": "LongTermSizeBasedPool-4398046511120: pool hwm since reboot", "nodeUUID": "dc1da44a-f532-11d4-9001-11b384af0bfe", "value": 0 } ] }