Read
GET v1/pools
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| id | NsObjectID |
| name | NsObjectName |
| full_name | NsObjectName |
| search_name | NsSearchName |
| description | NsDescription |
| creation_time | NsTime |
| last_modified | NsTime |
| capacity | NsBytes |
| usage | NsBytes |
| savings | NsBytes |
| savings_compression | NsBytes |
| savings_dedupe | NsBytes |
| savings_clone | NsBytes |
| savings_vol_thin_provisioning | NsBytes |
| unused_reserve | NsBytes |
| free_space | NsBytes |
| cache_capacity | NsBytes |
| pinnable_cache_capacity | NsBytes |
| pinned_cache_capacity | NsBytes |
| savings_ratio | NsRatio |
| compression_ratio | NsRatio |
| dedupe_ratio | NsRatio |
| clone_ratio | NsRatio |
| vol_thin_provisioning_ratio | NsRatio |
| snapcoll_count | NsUnsignedLong |
| snap_count | NsUnsignedLong |
| array_count | NsUnsignedLong |
| vol_count | NsUnsignedLong |
| force | NsBoolean |
| usage_valid | NsBoolean |
| all_flash | NsBoolean |
| dedupe_capable | NsBoolean |
GET v1/pools/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| fields | NsCommaSeparatedList |
| id | NsObjectID |
| name | NsObjectName |
| full_name | NsObjectName |
| search_name | NsSearchName |
| description | NsDescription |
| creation_time | NsTime |
| last_modified | NsTime |
| capacity | NsBytes |
| usage | NsBytes |
| savings | NsBytes |
| savings_compression | NsBytes |
| savings_dedupe | NsBytes |
| savings_clone | NsBytes |
| savings_vol_thin_provisioning | NsBytes |
| unused_reserve | NsBytes |
| free_space | NsBytes |
| cache_capacity | NsBytes |
| pinnable_cache_capacity | NsBytes |
| pinned_cache_capacity | NsBytes |
| savings_ratio | NsRatio |
| compression_ratio | NsRatio |
| dedupe_ratio | NsRatio |
| clone_ratio | NsRatio |
| vol_thin_provisioning_ratio | NsRatio |
| snapcoll_count | NsUnsignedLong |
| snap_count | NsUnsignedLong |
| array_count | NsUnsignedLong |
| vol_count | NsUnsignedLong |
| force | NsBoolean |
| usage_valid | NsBoolean |
| all_flash | NsBoolean |
| dedupe_capable | NsBoolean |
Description
Read a set of pools or a single pool.
Normal Response Codes
200
HTTP Error Codes
400 401 404 500 503
Detail Error Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the pool. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | Name of pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| full_name | NsObjectName | string | Fully qualified name of pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| search_name | NsSearchName | string | Name of pool used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'. | |
| description | NsDescription | string | Text description of pool. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| creation_time | NsTime | number | Time when this pool was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this pool was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| capacity | NsBytes | number | Total storage space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| usage | NsBytes | number | Used space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| savings | NsBytes | number | Overall space usage savings in the pool. Unsigned 64-bit integer. Example: '1234'. | |
| savings_compression | NsBytes | number | Space usage savings in the pool due to compression. Unsigned 64-bit integer. Example: '1234'. | |
| savings_dedupe | NsBytes | number | Space usage savings in the pool due to deduplication. Unsigned 64-bit integer. Example: '1234'. | |
| savings_clone | NsBytes | number | Space usage savings in the pool due to cloning of volumes. Unsigned 64-bit integer. Example: '1234'. | |
| savings_vol_thin_provisioning | NsBytes | number | Space usage savings in the pool due to thin provisioning of volumes. Unsigned 64-bit integer. Example: '1234'. | |
| unused_reserve | NsBytes | number | Unused reserve space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| free_space | NsBytes | number | Free space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| cache_capacity | NsBytes | number | Total usable cache capacity of the pool in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| pinnable_cache_capacity | NsBytes | number | Total pinnable cache capacity of the pool in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| pinned_cache_capacity | NsBytes | number | Total pinned cache capacity of the pool in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| savings_ratio | NsRatio | number | Overall space usage savings in the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| compression_ratio | NsRatio | number | Compression savings for the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| dedupe_ratio | NsRatio | number | Dedupe savings for the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| clone_ratio | NsRatio | number | Clone savings for the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| vol_thin_provisioning_ratio | NsRatio | number | Thin provisioning savings for volumes in the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| snapcoll_count | NsUnsignedLong | number | Snapshot collection count. Unsigned 64-bit integer. Example: 1234. | |
| snap_count | NsUnsignedLong | number | Snapshot count. Unsigned 64-bit integer. Example: 1234. | |
| array_count | NsUnsignedLong | number | Number of arrays in the pool. Unsigned 64-bit integer. Example: 1234. | |
| vol_count | NsUnsignedLong | number | Number of volumes assigned to the pool. Unsigned 64-bit integer. Example: 1234. | |
| array_list | NsArrayDetailList | Array of NsArrayDetail | List of arrays in the pool with detailed information. When create/update array list, only arrays' id is required. List of arrays' detailed information. | |
| unassigned_array_list | NsArraySummaryList | Array of NsArraySummary | List of arrays being unassigned from the pool. List of arrays' information. Each item contains array_name and array_id for the array name and its ID respectively. | |
| vol_list | NsVolumeList | Array of NsVolumeSummary | The list of volumes in the pool. List of volumes associated with a volume collection. | |
| pinned_vol_list | NsPinnedVolumeInfoList | Array of NsPinnedVolumeInfo | The list of pinned volumes in the pool. List of pinned volumes in a pool. | |
| force | NsBoolean | boolean | Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Possible values: 'true', 'false'. | |
| usage_valid | NsBoolean | boolean | Indicates whether the usage of pool is valid. Possible values: 'true', 'false'. | |
| all_flash | NsBoolean | boolean | Indicate whether the pool is an all_flash pool. Possible values: 'true', 'false'. | |
| dedupe_capable | NsBoolean | boolean | Indicates whether the pool is capable of hosting deduped volumes. Possible values: 'true', 'false'. |
JSON Response