Get 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

Retrieves system statistics data for file storage.

HTTP request syntax (URI)

GET <base_URI>/v7/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:
  • TOTAL_OPERATION_PER_SEC
  • FILESYSTEM_OPERATIONS_VALUE
  • NVRAM_WAITED_ALLOCS
  • FSB_FILESYSTEM_LOAD
  • FSA_FILESYSTEM_LOAD
  • 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 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 a pre-defined search string

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.239.120:8444/v7/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/v7/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
      }
   ]
}