Read
GET v1/space_domains
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| pool_id | NsObjectID |
| pool_name | NsObjectName |
| app_category_id | NsObjectID |
| app_category_name | NsPerfPolicyName |
| sample_rate | NsUnsignedLong |
| volume_count | NsUnsignedLong |
| deduped_volume_count | NsUnsignedLong |
| block_size | NsBytes |
| deduped | NsBoolean |
| encrypted | NsBoolean |
| usage | NsBytes |
| vol_logical_usage | NsBytes |
| snap_logical_usage | NsBytes |
| vol_mapped_usage | NsBytes |
| logical_dedupe_usage | NsBytes |
| physical_dedupe_usage | NsBytes |
| savings_compression | NsBytes |
| savings_dedupe | NsBytes |
| savings_clone | NsBytes |
| compressed_usage_bytes | NsBytes |
| uncompressed_usage_bytes | NsBytes |
| compression_ratio | NsRatio |
| dedupe_ratio | NsRatio |
| clone_ratio | NsRatio |
GET v1/space_domains/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| pool_id | NsObjectID |
| pool_name | NsObjectName |
| app_category_id | NsObjectID |
| app_category_name | NsPerfPolicyName |
| sample_rate | NsUnsignedLong |
| volume_count | NsUnsignedLong |
| deduped_volume_count | NsUnsignedLong |
| block_size | NsBytes |
| deduped | NsBoolean |
| encrypted | NsBoolean |
| usage | NsBytes |
| vol_logical_usage | NsBytes |
| snap_logical_usage | NsBytes |
| vol_mapped_usage | NsBytes |
| logical_dedupe_usage | NsBytes |
| physical_dedupe_usage | NsBytes |
| savings_compression | NsBytes |
| savings_dedupe | NsBytes |
| savings_clone | NsBytes |
| compressed_usage_bytes | NsBytes |
| uncompressed_usage_bytes | NsBytes |
| compression_ratio | NsRatio |
| dedupe_ratio | NsRatio |
| clone_ratio | NsRatio |
Description
List a set of space domains.
Normal Response Codes
200 206
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the space domain. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| pool_id | NsObjectID | string | Identifier associated with the pool in the storage pool table. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| pool_name | NsObjectName | string | Name of the pool containing the space domain. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| app_category_id | NsObjectID | string | Identifier of the application category associated with the space domain. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| app_category_name | NsPerfPolicyName | string | Name of the application category associated with the space domain. String of up to 64 alphanumeric characters, - and . and : and space are allowed after first character. Example: 'SQL Server Logs'. | |
| perf_policy_names | NsPerfPolicyNameList | Array of NsPerfPolicySummary | Name of the performance policies associated with the space domain. List of Performance Policies. | |
| sample_rate | NsUnsignedLong | number | Sample rate value. Unsigned 64-bit integer. Example: 1234. | |
| volume_count | NsUnsignedLong | number | Number of volumes belonging to the space domain. Unsigned 64-bit integer. Example: 1234. | |
| deduped_volume_count | NsUnsignedLong | number | Number of deduplicated volumes belonging to the space domain. Unsigned 64-bit integer. Example: 1234. | |
| volumes | NsVolumeList | Array of NsVolumeSummary | Volumes belonging to the space domain. List of volumes. | |
| block_size | NsBytes | number | Block size in bytes of volumes belonging to the space domain. Unsigned 64-bit integer. Example: '1234'. | |
| deduped | NsBoolean | boolean | Volumes in space domain are deduplicated by default. Possible values: 'true', 'false'. | |
| encrypted | NsBoolean | boolean | Volumes in space domain are encrypted. Possible values: 'true', 'false'. | |
| usage | NsBytes | number | Physical space usage of volumes in the space domain. Unsigned 64-bit integer. Example: '1234'. | |
| vol_logical_usage | NsBytes | number | Logical usage of volumes in the space domain. Unsigned 64-bit integer. Example: '1234'. | |
| snap_logical_usage | NsBytes | number | Logical usage of snapshots in the space domain. Unsigned 64-bit integer. Example: '1234'. | |
| vol_mapped_usage | NsBytes | number | Mapped usage of volumes in the space domain, useful for computing clone savings. Unsigned 64-bit integer. Example: '1234'. | |
| logical_dedupe_usage | NsBytes | number | Logical space usage of volumes when deduped. Unsigned 64-bit integer. Example: '1234'. | |
| physical_dedupe_usage | NsBytes | number | Physical space usage of volumes including snapshots when deduped. Unsigned 64-bit integer. Example: '1234'. | |
| savings_compression | NsBytes | number | Space usage savings in the space domain due to compression. Unsigned 64-bit integer. Example: '1234'. | |
| savings_dedupe | NsBytes | number | Space usage savings in the space domain due to deduplication. Unsigned 64-bit integer. Example: '1234'. | |
| savings_clone | NsBytes | number | Space usage savings in the space domain due to cloning of volumes. Unsigned 64-bit integer. Example: '1234'. | |
| compressed_usage_bytes | NsBytes | number | Compressed usage of volumes and snapshots in the space domain. Unsigned 64-bit integer. Example: '1234'. | |
| uncompressed_usage_bytes | NsBytes | number | Uncompressed usage of volumes and snapshots in the space domain. Unsigned 64-bit integer. Example: '1234'. | |
| compression_ratio | NsRatio | number | Compression savings for the space domain expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| dedupe_ratio | NsRatio | number | Deduplication savings for the space domain expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| clone_ratio | NsRatio | number | Clone savings for the space domain expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. |
JSON Response
{
"data": [
{
"app_category_id": "360000000000000000000000000000000000000009",
"app_category_name": "Other",
"block_size": 0,
"compression_ratio": 0.4342105263157895,
"dedupe_ratio": 0.6818181818181818,
"deduped": false,
"deduped_volume_count": 1,
"encrypted": false,
"id": "370000000000000000000000000000000000000001",
"pool_id": "0a00000000000004d3000000000000000000000001",
"pool_name": "default",
"savings_compression": 4300,
"savings_dedupe": 1050,
"usage": 2250,
"volume_count": 3,
"volumes": [
{
"id": "0600000000000004d3000000000000000000000002",
"vol_id": "0600000000000004d3000000000000000000000002",
"name": "bar",
"vol_name": "bar"
},
{
"id": "0600000000000004d3000000000000000000000003",
"vol_id": "0600000000000004d3000000000000000000000003",
"name": "baz",
"vol_name": "baz"
},
{
"id": "0600000000000004d3000000000000000000000001",
"vol_id": "0600000000000004d3000000000000000000000001",
"name": "foo",
"vol_name": "foo"
}
]
},
{
"app_category_id": "360000000000000000000000000000000000000008",
"app_category_name": "File Server",
"block_size": 0,
"compression_ratio": 1.0,
"dedupe_ratio": 1.0,
"deduped": false,
"deduped_volume_count": 0,
"encrypted": false,
"id": "370000000000000000000000000000000000000002",
"pool_id": "0a00000000000004d3000000000000000000000001",
"pool_name": "default",
"savings_compression": 0,
"savings_dedupe": 0,
"usage": 0,
"volume_count": 0,
"volumes": null
}
],
"endRow": 2,
"startRow": 0,
"totalRows": 2
}