REST API Reference Version 3.1.0.0Search

Read

GET v1/arrays

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
id NsObjectID
name NsObjectName
full_name NsObjectName
search_name NsSearchName
description NsDescription
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
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

GET v1/arrays/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
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
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

GET v1/arrays/id

Query parameters

Parameter Type
fields NsCommaSeparatedList

Description

Read one or more arrays.

Normal Response Codes

200

HTTP Error Codes

400 401 404 500 503

Detail Error Codes

SM_complex_type_query_param

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for array. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsObjectName string The user provided name of the array. It is also the array's hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
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'.  
description NsDescription string Text description of the array. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
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 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'.  
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.  
ten_gig_sfp_nic_port_count NsUnsignedLong number Count of 10G SFP NIC Ports installed on the array. Unsigned 64-bit integer. Example: 1234.  
ten_gig_t_nic_port_count NsUnsignedLong number Count of 10G BaseT NIC Ports installed on the array. Unsigned 64-bit integer. Example: 1234.  
fc_port_count NsUnsignedLong number Count of Fibre Channel Ports installed on the array. Unsigned 64-bit integer. Example: 1234.  

JSON Response

Parent topic: arrays