Read
GET v1/arrays
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsHostName |
| force | NsBoolean |
| full_name | NsObjectName |
| search_name | NsSearchName |
| status | NsArrayStatus |
| role | NsArrayRole |
| pool_name | NsObjectName |
| pool_id | NsObjectID |
| model | NsObjectName |
| serial | NsArraySerialNumber |
| version | NsObjectName |
| creation_time | NsTime |
| last_modified | NsTime |
| usage_valid | NsBoolean |
| usable_capacity_bytes | NsBytes |
| raw_capacity_bytes | NsBytes |
| vol_usage_bytes | NsBytes |
| vol_compression | NsRatio |
| vol_saved_bytes | NsBytes |
| snap_usage_bytes | NsBytes |
| snap_compression | NsRatio |
| snap_space_reduction | NsRatio |
| snap_saved_bytes | NsBytes |
| pending_delete_bytes | NsBytes |
| available_bytes | NsBytes |
| usage | NsBytes |
| all_flash | NsBoolean |
| dedupe_capacity_bytes | NsBytes |
| dedupe_usage_bytes | NsBytes |
| extended_model | NsObjectName |
| is_supported_hw_config | NsBoolean |
| gig_nic_port_count | NsUnsignedLong |
| ten_gig_sfp_nic_port_count | NsUnsignedLong |
| ten_gig_t_nic_port_count | NsUnsignedLong |
| fc_port_count | NsUnsignedLong |
| create_pool | NsBoolean |
| pool_description | NsDescription |
| ctrlr_a_support_ip | NsIPAddress |
| ctrlr_b_support_ip | NsIPAddress |
GET v1/arrays/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsHostName |
| force | NsBoolean |
| full_name | NsObjectName |
| search_name | NsSearchName |
| status | NsArrayStatus |
| role | NsArrayRole |
| pool_name | NsObjectName |
| pool_id | NsObjectID |
| model | NsObjectName |
| serial | NsArraySerialNumber |
| version | NsObjectName |
| creation_time | NsTime |
| last_modified | NsTime |
| usage_valid | NsBoolean |
| usable_capacity_bytes | NsBytes |
| raw_capacity_bytes | NsBytes |
| vol_usage_bytes | NsBytes |
| vol_compression | NsRatio |
| vol_saved_bytes | NsBytes |
| snap_usage_bytes | NsBytes |
| snap_compression | NsRatio |
| snap_space_reduction | NsRatio |
| snap_saved_bytes | NsBytes |
| pending_delete_bytes | NsBytes |
| available_bytes | NsBytes |
| usage | NsBytes |
| all_flash | NsBoolean |
| dedupe_capacity_bytes | NsBytes |
| dedupe_usage_bytes | NsBytes |
| extended_model | NsObjectName |
| is_supported_hw_config | NsBoolean |
| gig_nic_port_count | NsUnsignedLong |
| ten_gig_sfp_nic_port_count | NsUnsignedLong |
| ten_gig_t_nic_port_count | NsUnsignedLong |
| fc_port_count | NsUnsignedLong |
| create_pool | NsBoolean |
| pool_description | NsDescription |
| ctrlr_a_support_ip | NsIPAddress |
| ctrlr_b_support_ip | NsIPAddress |
Description
Read one or more arrays.
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 array. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsHostName | string | The user provided name of the array. It is also the array's hostname. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen. | |
| force | NsBoolean | boolean | Forcibly delete the specified array. Possible values: 'true', 'false'. | |
| full_name | NsObjectName | string | The array's fully qualified name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| search_name | NsSearchName | string | The array name used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'. | |
| status | NsArrayStatus | string enum | Reachability status of the array in the group. Reachability status of the array in the group, possible values: 'unreachable', 'reachable'. | |
| role | NsArrayRole | string enum | Role of the array in the group. Array's role in the group, possible values: 'invalid', 'leader', 'backup_leader', 'member', 'non_member', 'failed'. | |
| pool_name | NsObjectName | string | Name of pool to which this is a member. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| pool_id | NsObjectID | string | ID of pool to which this is a member. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| model | NsObjectName | string | Array model. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| serial | NsArraySerialNumber | string | Serial number of the array. Example: 'AC-109084'. | |
| version | NsObjectName | string | Software version of the array. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| creation_time | NsTime | number | Time when this array object was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this array object was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| usage_valid | NsBoolean | boolean | Indicates whether the usage of array is valid. Possible values: 'true', 'false'. | |
| usable_capacity_bytes | NsBytes | number | The usable capacity bytes of array. Unsigned 64-bit integer. Example: '1234'. | |
| raw_capacity_bytes | NsBytes | number | The raw capacity bytes of array. Unsigned 64-bit integer. Example: '1234'. | |
| vol_usage_bytes | NsBytes | number | The compressed usage of volumes in array. Unsigned 64-bit integer. Example: '1234'. | |
| vol_compression | NsRatio | number | The compression rate of volumes in array expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| vol_saved_bytes | NsBytes | number | The saved space of volumes in array. Unsigned 64-bit integer. Example: '1234'. | |
| snap_usage_bytes | NsBytes | number | The compressed usage of snapshots in array. Unsigned 64-bit integer. Example: '1234'. | |
| snap_compression | NsRatio | number | The compression rate of snapshots in array expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| snap_space_reduction | NsRatio | number | The space reduction rate of snapshots in array expressed as ratio. Fraction expressed as floating point number. Example: '9.18'. | |
| snap_saved_bytes | NsBytes | number | The saved space of snapshots in array. Unsigned 64-bit integer. Example: '1234'. | |
| pending_delete_bytes | NsBytes | number | The pending delete bytes in array. Unsigned 64-bit integer. Example: '1234'. | |
| available_bytes | NsBytes | number | The available space of array. Unsigned 64-bit integer. Example: '1234'. | |
| usage | NsBytes | number | Used space of the array in bytes. Unsigned 64-bit integer. Example: '1234'. | |
| all_flash | NsBoolean | boolean | Whether it is an all-flash array. Possible values: 'true', 'false'. | |
| dedupe_capacity_bytes | NsBytes | number | The dedupe capacity of a hybrid array. Does not apply to all-flash arrays. Unsigned 64-bit integer. Example: '1234'. | |
| dedupe_usage_bytes | NsBytes | number | The dedupe usage of a hybrid array. Does not apply to all-flash arrays. Unsigned 64-bit integer. Example: '1234'. | |
| extended_model | NsObjectName | string | Extended model of the array. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| is_supported_hw_config | NsBoolean | boolean | Whether it is a supported hardware config. Possible values: 'true', 'false'. | |
| gig_nic_port_count | NsUnsignedLong | number | Count of 1G NIC Ports installed on the array. Unsigned 64-bit integer. Example: 1234. | Yes |
| ten_gig_sfp_nic_port_count | NsUnsignedLong | number | Count of 10G SFP NIC Ports installed on the array. Unsigned 64-bit integer. Example: 1234. | Yes |
| ten_gig_t_nic_port_count | NsUnsignedLong | number | Count of 10G BaseT NIC Ports installed on the array. Unsigned 64-bit integer. Example: 1234. | Yes |
| fc_port_count | NsUnsignedLong | number | Count of Fibre Channel Ports installed on the array. Unsigned 64-bit integer. Example: 1234. | Yes |
| create_pool | NsBoolean | boolean | Whether to create associated pool during array create. Possible values: 'true', 'false'. | |
| pool_description | NsDescription | string | Text description of the pool to be created during array creation. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| ctrlr_a_support_ip | NsIPAddress | string | Controller A Support IP Address. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | |
| ctrlr_b_support_ip | NsIPAddress | string | Controller B Support IP Address. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | |
| nic_list | NsNICList | Array of NsNIC | List NICs information. Used when creating an array. List of NICs. |
JSON Response
{
"startRow" : 0,
"totalRows" : 4,
"endRow" : 4,
"data" : [
{
"vol_compression" : 0,
"model" : "desktop",
"vol_saved_bytes" : 0,
"usable_capacity_bytes" : 3983343616,
"snap_saved_bytes" : 0,
"pool_id" : "0a00000000000004d3000000000000000000000001",
"creation_time" : 1310410358,
"id" : "0900000000000004d3000000000000000000000001",
"snap_space_reduction" : 0,
"raw_capacity_bytes" : 0,
"version" : "1.0.0.2",
"pending_delete_bytes" : 0,
"search_name" : "g1a1",
"serial" : "g1a1",
"last_modified" : 1310410358,
"name" : "g1a1",
"description" : "",
"full_name" : "g1a1",
"snap_usage_bytes" : 0,
"snap_compression" : 0,
"vol_usage_bytes" : 0,
"available_bytes" : 3983343616,
"pool_name" : "default"
},
{
"vol_compression" : 0,
"model" : "desktop",
"vol_saved_bytes" : 0,
"usable_capacity_bytes" : 3983343616,
"snap_saved_bytes" : 0,
"pool_id" : "0a00000000000004d3000000000000000000000001",
"creation_time" : 1310410358,
"id" : "0900000000000004d3000000000000000000000002",
"snap_space_reduction" : 0,
"raw_capacity_bytes" : 0,
"version" : "1.0.0.2",
"pending_delete_bytes" : 0,
"search_name" : "g1a2",
"serial" : "g1a2",
"last_modified" : 1310410358,
"name" : "g1a2",
"description" : "",
"full_name" : "g1a2",
"snap_usage_bytes" : 0,
"snap_compression" : 0,
"vol_usage_bytes" : 0,
"available_bytes" : 3983343616,
"pool_name" : "default"
},
{
"vol_compression" : 0,
"model" : "desktop",
"vol_saved_bytes" : 0,
"usable_capacity_bytes" : 3983343616,
"snap_saved_bytes" : 0,
"pool_id" : "",
"creation_time" : 1310410358,
"id" : "0900000000000004d3000000000000000000000003",
"snap_space_reduction" : 0,
"raw_capacity_bytes" : 0,
"version" : "1.0.0.2",
"pending_delete_bytes" : 0,
"search_name" : "g1a3",
"serial" : "g1a3",
"last_modified" : 1310410358,
"name" : "g1a3",
"description" : "",
"full_name" : "g1a3",
"snap_usage_bytes" : 0,
"snap_compression" : 0,
"vol_usage_bytes" : 0,
"available_bytes" : 3983343616,
"pool_name" : ""
},
{
"vol_compression" : 0,
"model" : "desktop",
"vol_saved_bytes" : 0,
"usable_capacity_bytes" : 3983343616,
"snap_saved_bytes" : 0,
"pool_id" : "",
"creation_time" : 1310410358,
"id" : "0900000000000004d3000000000000000000000004",
"snap_space_reduction" : 0,
"raw_capacity_bytes" : 0,
"version" : "1.0.0.2",
"pending_delete_bytes" : 0,
"search_name" : "g1a4",
"serial" : "g1a4",
"last_modified" : 1310410358,
"name" : "g1a4",
"description" : "",
"full_name" : "g1a4",
"snap_usage_bytes" : 0,
"snap_compression" : 0,
"vol_usage_bytes" : 0,
"available_bytes" : 3983343616,
"pool_name" : ""
}
]
}