Get multiple file storage system statistics

NAS File Storage REST API v7 Reference

Version
14.7.x
14.6.x
Audience
anonymous
Part Number
MK-92HNAS088-05

Allows multiple search queries to be specified when retrieving file storage system statistics. This API call works in the same way as “Get file storage system statistics”, but takes a list of query string values, allowing more statistics to be returned in a single API call.

HTTP request syntax (URI)

GET <base_URI>/v7/storage/statistics

Parameters

Name Type Required Values Description
systemStatsType BODY Y array Each array item 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:
  • TOTAL_OPERATIO

    N_PER_SEC
  • FILESYSTEM_OPE

    RATIONS_VALUE

  • NVRAM_WAITED_

    ALLOCS

  • FSB_FILESYSTEM

    _LOAD

  • FSA_FILESYSTEM

    _LOAD

  • FSI_CACHE_USA

    GE

  • HEAP_USAGE
  • FIBRECHANNEL_T

    HROUGHPUT_RX

  • FIBRECHANNEL_T

    HROUGHPUT_TX

  • ETHERNET_THRO

    UGHPUT_RX

  • ETHERNET_THRO

    UGHPUT_TX

  • MFB_LOAD
  • MMB_LOAD
  • DISK_READ_LATE

Return codes

Code Data Description
200 storageStatistics A storageStatistics object is retrieved successfully.
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

Any HTTP status code other than 200 indicates that the API did not complete successfully.

Request example using multiple search strings

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC"
https://172.17.239.120:8444/v7/storage/statistics -X GET -d '{"systemStatsType": ["HEAP_USAGE", "MFB_LOAD", "111"]}'

Response example using multiple search strings

HTTP/1.1 200 OK
{
  "storageStatistics": [
    {
      "name": "Heap Usage (%)",
      "nodeUUID": "48fbe624-4c33-11d0-9001-9c5547075e75",
      "value": 77
    },
    {
      "name": "LongTermSizeBasedPool-4398046511120: pool current",
      "nodeUUID": "48fbe624-4c33-11d0-9001-9c5547075e75",
      "value": 0
    },
    {
      "name": "LongTermSizeBasedPool-4398046511120: pool hwm since reboot",
      "nodeUUID": "48fbe624-4c33-11d0-9001-9c5547075e75",
      "value": 0
    },
    {
      "name": "MFB Load (%)",
      "nodeUUID": "48fbe624-4c33-11d0-9001-9c5547075e75",
      "value": 3
    }
  ]
}