Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Get multiple file storage system statistics

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>/v8/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_OPERATION_PER_SEC
  • FILESYSTEM_OPERATIONS_VALUE
  • NVRAM_WAITED_ALLOCS
  • FSI_CACHE_USAGE
  • HEAP_USAGE
  • FIBRECHANNEL_THROUGHPUT_RX
  • FIBRECHANNEL_THROUGHPUT_TX
  • ETHERNET_THROUGHPUT_RX
  • ETHERNET_THROUGHPUT_TX
  • MFB_LOAD
  • MMB_LOAD
  • DISK_READ_LATENCY
  • DISK_WRITE_LATENCY
  • DISK_STRIPE_WRITE_LATENCY
  • RUNNING_BOSSOCK_FIBRES
  • PI_TCP_SOCKETS_RECEIVE_FIBRES
  • CONTEXT_NODE
  • CONTEXT_FILESYSTEMS
  • CONTEXT_ALL
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.

Both the examples below are equivalent, supplying the same parameters, but in different ways, and should both return the same response.

Request example 1, using multiple search strings supplied as part if the request body
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC"
https://172.17.239.120:8444/v8/storage/statistics -X GET -d '{"systemStatsType": ["HEAP_USAGE", "MFB_LOAD", "111"]}'
Request example 2, using multiple search strings supplied as part of the URI
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC"
https://172.17.239.120:8444/v8/storage/statistics?systemStatsType=HEAP_USAGE&systemStatsType=MFB_LOAD&systemStatsType=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
    }
  ]
}

 

  • Was this article helpful?