REST API - GET Storage Pool
This operation returns a list of storage pools.
Request
Syntax
GET <webservice>/StoragePool HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
Name |
Description |
Host |
The host name of the Web Server or Web Console used in the API request. |
Accept |
The format of the response. Valid values are: application/xml or application/json. |
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter |
Description |
Element |
totalFreeSpace |
The total amount of free space in the storage pool. |
storagePoolList |
totalCapacity |
The total size of the storage pool. |
storagePoolList |
storagePoolType |
The storage policy type. |
storagePoolList |
status |
The status of the storage pool |
storagePoolList |
reserved1 |
The reservation status. |
storagePoolList |
numberOfNodes |
Number of nodes in the storage pool. |
storagePoolList |
clientGroupName |
client group associated with the storage pool. |
storagePool |
clientGroupId |
The system-generated ID assigned for the client group. |
storagePool |
_type_ |
Storage pool type. |
storagePool |
_type_ |
|
storagePoolEntity |
storagePoolName |
Name of the storage pool. |
storagePoolEntity |
storagePoolId |
The system-generated ID assigned for the storage pool. |
storagePoolEntity |
Examples
Sample Request
GET <webservice>/StoragePool HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<Api_GetStoragePoolListResp>
<storagePoolList totalFreeSpace="82323785646" totalCapacity="107374182400" storagePoolType="1" status="Online (1 of 2 nodes offline)" reserved1="1" numberOfNodes="2">
<storagePool clientGroupName="UNc-Pool" clientGroupId="334" _type_="28"/>
<storagePoolEntity _type_="160" storagePoolName="UNc-Pool" storagePoolId="334"/>
</storagePoolList>
</Api_GetStoragePoolListResp>
Last modified: 1/10/2018 7:55:03 PM