Read

GET v1/volumes

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
pageSize NsUnsignedInt
id NsObjectID
name NsVolSnapName
full_name NsVolSnapName
search_name NsSearchName
size NsUnsignedLong
description NsDescription
perfpolicy_name NsObjectName
perfpolicy_id NsObjectID
reserve NsPercent
warn_level NsPercent
limit NsPercent
snap_reserve NsUnsignedLong
snap_warn_level NsUnsignedLong
snap_limit NsUnsignedLong
snap_limit_percent NsSignedLong
num_snaps NsUnsignedLong
projected_num_snaps NsUnsignedLong
online NsBoolean
owned_by_group NsObjectName
owned_by_group_id NsObjectID
multi_initiator NsBoolean
pool_name NsObjectName
pool_id NsObjectID
read_only NsBoolean
serial_number NsISCSISerialNumber
target_name NsTargetName
block_size NsBytes
offline_reason NsOfflineReason
clone NsBoolean
parent_vol_name NsVolSnapName
parent_vol_id NsObjectID
base_snap_name NsVolSnapName
base_snap_id NsObjectID
volcoll_name NsObjectName
volcoll_id NsOptionalObjectID
agent_type NsAgentType
force NsBoolean
creation_time NsTime
last_modified NsTime
protection_type NsProtectionType
dest_pool_name NsObjectName
dest_pool_id NsObjectID
move_start_time NsTime
move_aborting NsBoolean
move_bytes_migrated NsBytes
move_bytes_remaining NsBytes
move_est_compl_time NsTime
usage_valid NsBoolean
space_usage_level NsSpaceUsageLevel
total_usage_bytes NsBytes
vol_usage_compressed_bytes NsBytes
vol_usage_uncompressed_bytes NsBytes
snap_usage_compressed_bytes NsBytes
snap_usage_uncompressed_bytes NsBytes
snap_usage_populated_bytes NsBytes
cache_pinned NsBoolean
pinned_cache_size NsBytes
cache_needed_for_pin NsBytes
upstream_cache_pinned NsBoolean
cache_policy NsCachePolicy
thinly_provisioned NsBoolean
vol_state NsVolStatus
num_connections NsUnsignedLong
num_iscsi_connections NsUnsignedLong
num_fc_connections NsUnsignedLong
encryption_cipher NsEncryptionCipher
app_uuid NsAppUuid
folder_id NsOptionalObjectID
folder_name NsObjectName
caching_enabled NsBoolean
previously_deduped NsBoolean
dedupe_enabled NsBoolean
vpd_t10 NsString
vpd_ieee0 NsString
vpd_ieee1 NsString
app_category NsString
limit_iops NsSignedLong
limit_mbps NsSignedLong
pre_filter NsString

GET v1/volumes/detail

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
fields NsCommaSeparatedList
pageSize NsUnsignedInt
id NsObjectID
name NsVolSnapName
full_name NsVolSnapName
search_name NsSearchName
size NsUnsignedLong
description NsDescription
perfpolicy_name NsObjectName
perfpolicy_id NsObjectID
reserve NsPercent
warn_level NsPercent
limit NsPercent
snap_reserve NsUnsignedLong
snap_warn_level NsUnsignedLong
snap_limit NsUnsignedLong
snap_limit_percent NsSignedLong
num_snaps NsUnsignedLong
projected_num_snaps NsUnsignedLong
online NsBoolean
owned_by_group NsObjectName
owned_by_group_id NsObjectID
multi_initiator NsBoolean
pool_name NsObjectName
pool_id NsObjectID
read_only NsBoolean
serial_number NsISCSISerialNumber
target_name NsTargetName
block_size NsBytes
offline_reason NsOfflineReason
clone NsBoolean
parent_vol_name NsVolSnapName
parent_vol_id NsObjectID
base_snap_name NsVolSnapName
base_snap_id NsObjectID
volcoll_name NsObjectName
volcoll_id NsOptionalObjectID
agent_type NsAgentType
force NsBoolean
creation_time NsTime
last_modified NsTime
protection_type NsProtectionType
dest_pool_name NsObjectName
dest_pool_id NsObjectID
move_start_time NsTime
move_aborting NsBoolean
move_bytes_migrated NsBytes
move_bytes_remaining NsBytes
move_est_compl_time NsTime
usage_valid NsBoolean
space_usage_level NsSpaceUsageLevel
total_usage_bytes NsBytes
vol_usage_compressed_bytes NsBytes
vol_usage_uncompressed_bytes NsBytes
snap_usage_compressed_bytes NsBytes
snap_usage_uncompressed_bytes NsBytes
snap_usage_populated_bytes NsBytes
cache_pinned NsBoolean
pinned_cache_size NsBytes
cache_needed_for_pin NsBytes
upstream_cache_pinned NsBoolean
cache_policy NsCachePolicy
thinly_provisioned NsBoolean
vol_state NsVolStatus
num_connections NsUnsignedLong
num_iscsi_connections NsUnsignedLong
num_fc_connections NsUnsignedLong
encryption_cipher NsEncryptionCipher
app_uuid NsAppUuid
folder_id NsOptionalObjectID
folder_name NsObjectName
caching_enabled NsBoolean
previously_deduped NsBoolean
dedupe_enabled NsBoolean
vpd_t10 NsString
vpd_ieee0 NsString
vpd_ieee1 NsString
app_category NsString
limit_iops NsSignedLong
limit_mbps NsSignedLong
pre_filter NsString

GET v1/volumes/id

Query parameters

Parameter Type
fields NsCommaSeparatedList

Description

Retrieve information on a set of volumes or a single volume.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Detail 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 the volume. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsVolSnapName string Name of the volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.  
full_name NsVolSnapName string Fully qualified name of volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.  
search_name NsSearchName string Name of volume used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.  
size NsUnsignedLong number Volume size in megabytes. Size is required for creating a volume but not for cloning an existing volume. Unsigned 64-bit integer. Example: 1234.  
description NsDescription string Text description of volume. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
perfpolicy_name NsObjectName string Name of performance policy. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
perfpolicy_id NsObjectID string Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
reserve NsPercent number Amount of space to reserve for this volume as a percentage of volume size. Percentage as integer from 0 to 100.  
warn_level NsPercent number Threshold for available space as a percentage of volume size below which an alert is raised. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume. Percentage as integer from 0 to 100.  
limit NsPercent number Limit for the volume as a percentage of volume size. Percentage as integer from 0 to 100.  
snap_reserve NsUnsignedLong number Amount of space to reserve for snapshots of this volume as a percentage of volume size. Unsigned 64-bit integer. Example: 1234.  
snap_warn_level NsUnsignedLong number Threshold for available space as a percentage of volume size below which an alert is raised. Unsigned 64-bit integer. Example: 1234.  
snap_limit NsUnsignedLong number Limit for the space used by the volume's snapshots, expressed either as a percentage of the volume's size or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no limit. If this option is not specified when the volume is created, the group's default snapshot limit will be used. This attribute is superseded by snap_limit_percent. Unsigned 64-bit integer. Example: 1234. Yes
snap_limit_percent NsSignedLong number Limit for the space used by the volume's snapshots, expressed either as a percentage of the volume's size or as -1 to indicate that there is no limit. If this option is not specified when the volume is created, the group's default snapshot limit will be used. Signed 64-bit integer. Example: -1234.  
num_snaps NsUnsignedLong number Number of live, non-hidden snapshots for this volume. Unsigned 64-bit integer. Example: 1234.  
projected_num_snaps NsUnsignedLong number Depricated. Projected number of snapshots (including schedued and manual) for this volume. Unsigned 64-bit integer. Example: 1234. Yes
online NsBoolean boolean Online state of volume, available for host initiators to establish connections. Possible values: 'true', 'false'.  
owned_by_group NsObjectName string Name of group that currently owns the volume. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
owned_by_group_id NsObjectID string ID of group that currently owns the volume. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
multi_initiator NsBoolean boolean This indicates whether volume and its snapshots are multi-initiator accessible. This attribute applies only to volumes and snapshots available to iSCSI initiators. Possible values: 'true', 'false'.  
pool_name NsObjectName string Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
pool_id NsObjectID string Identifier associated with the pool in the storage pool table. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
read_only NsBoolean boolean Volume is read-only. Possible values: 'true', 'false'.  
serial_number NsISCSISerialNumber string Identifier associated with the volume for the SCSI protocol. A 32 digit hexadecimal number. Example: '1234123412341234abcdacbdacbdacbd'.  
target_name NsTargetName string The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume. The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target.  
block_size NsBytes number Size in bytes of blocks in the volume. Unsigned 64-bit integer. Example: '1234'.  
offline_reason NsOfflineReason string enum Volume offline reason. Possible values: 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'over_snapshot_reserve', 'nvram_loss_recovery', 'serial_number_collision', 'encryption_inactive', 'encryption_key_deleted', 'vvol_unbind', 'cache_unpin_in_progress'.  
clone NsBoolean boolean Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true. Possible values: 'true', 'false'.  
parent_vol_name NsVolSnapName string Name of parent volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.  
parent_vol_id NsObjectID string Parent volume ID. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
base_snap_name NsVolSnapName string Name of base snapshot. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.  
base_snap_id NsObjectID string Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
volcoll_name NsObjectName string Name of volume collection of which this volume is a member. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
volcoll_id NsOptionalObjectID string ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string. An optional NsObjectID. A 42 digit hexadecimal number or the empty string. Example: '1234123412341234123412341234123412341234cd' or ''.  
agent_type NsAgentType string enum External management agent type. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'.  
force NsBoolean boolean Forcibly offline, reduce size or change read-only status a volume. Possible values: 'true', 'false'.  
creation_time NsTime number Time when this volume was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time when this volume was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
protection_type NsProtectionType string enum Specifies if volume is protected with schedules. If protected, indicate whether replication is setup. Volume Collection or volume is protected locally or remotely or unprotected. Possible values: 'local', 'remote' or 'unprotected'.  
last_snap NsSnapSummary object Last snapshot for this volume. Select fields containing snapshot information.  
last_replicated_snap NsSnapSummary object Last replicated snapshot for this volume. Select fields containing snapshot information.  
dest_pool_name NsObjectName string Name of the destination pool where the volume is moving to. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
dest_pool_id NsObjectID string ID of the destination pool where the volume is moving to. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
move_start_time NsTime number The Start time when this volume was moved. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
move_aborting NsBoolean boolean This indicates whether the move of the volume is aborting or not. Possible values: 'true', 'false'.  
move_bytes_migrated NsBytes number The bytes of volume which have been moved. Unsigned 64-bit integer. Example: '1234'.  
move_bytes_remaining NsBytes number The bytes of volume which have not been moved. Unsigned 64-bit integer. Example: '1234'.  
move_est_compl_time NsTime number The estimated time of completion of a move. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
usage_valid NsBoolean boolean This indicates whether usage information of volume and snapshots are valid or not. Possible values: 'true', 'false'.  
space_usage_level NsSpaceUsageLevel string enum Indicates space usage level based on warning level. Possible values: 'normal', 'warning', 'critical'.  
total_usage_bytes NsBytes number Sum of compressed data and compressed backup data in bytes of this volume. Unsigned 64-bit integer. Example: '1234'.  
vol_usage_compressed_bytes NsBytes number Compressed data in bytes for this volume. Unsigned 64-bit integer. Example: '1234'.  
vol_usage_uncompressed_bytes NsBytes number Uncompressed data in bytes for this volume. Unsigned 64-bit integer. Example: '1234'.  
snap_usage_compressed_bytes NsBytes number Sum of compressed backup data in bytes stored in snapshots of this volume. Unsigned 64-bit integer. Example: '1234'.  
snap_usage_uncompressed_bytes NsBytes number Sum of uncompressed unique backup data in bytes stored in snapshots of this volume. Unsigned 64-bit integer. Example: '1234'.  
snap_usage_populated_bytes NsBytes number Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots. Unsigned 64-bit integer. Example: '1234'.  
cache_pinned NsBoolean boolean If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume. Possible values: 'true', 'false'.  
pinned_cache_size NsBytes number The amount of flash pinned on the volume. Unsigned 64-bit integer. Example: '1234'.  
cache_needed_for_pin NsBytes number The amount of flash needed to pin the volume. Unsigned 64-bit integer. Example: '1234'.  
upstream_cache_pinned NsBoolean boolean This indicates whether the upstream volume is cache pinned or not. Possible values: 'true', 'false'.  
cache_policy NsCachePolicy string enum Cache policy applied to the volume. Possible values: 'disabled', 'normal', 'aggressive', 'no_write', 'aggressive_read_no_write'.  
thinly_provisioned NsBoolean boolean Allow volume to be advertised as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. This change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently. Possible values: 'true', 'false'.  
vol_state NsVolStatus string enum Status of the volume. Possible values: 'online', 'offline', 'non_writable', 'read_only', 'login_only'.  
online_snaps NsSnapshotListFromVolumes Array of NsSnapshotFromVolumes The list of online snapshots of this volume. Snapshot list as presented in volumes object set.  
num_connections NsUnsignedLong number Number of connections of this volume. Unsigned 64-bit integer. Example: 1234.  
num_iscsi_connections NsUnsignedLong number Number of iscsi connections of this volume. Unsigned 64-bit integer. Example: 1234.  
num_fc_connections NsUnsignedLong number Number of Fibre Channel connections of this volume. Unsigned 64-bit integer. Example: 1234.  
access_control_records NsAccessControlRecords Array of NsAccessControlRecord List of access control records that apply to this volume. List of access control records associated with a volume or snapshot or protocol endpoint.  
encryption_cipher NsEncryptionCipher string enum The encryption cipher of the volume. Possible values: 'none', 'aes_256_xts'.  
app_uuid NsAppUuid string Application identifier of volume. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. Example: 'rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18'.  
folder_id NsOptionalObjectID string ID of the folder holding this volume. An optional NsObjectID. A 42 digit hexadecimal number or the empty string. Example: '1234123412341234123412341234123412341234cd' or ''.  
folder_name NsObjectName string Name of the folder holding this volume. It can be empty. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
metadata NsKeyValues Array of NsKeyValue Key-value pairs that augment a volume's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed.  
iscsi_sessions NsISCSISessions Array of NsISCSISession List of iSCSI sessions connected to this volume. List of iSCSI initiator sessions information.  
fc_sessions NsFCSessions Array of NsFCSession List of Fibre Channel sessions connected to this volume. List of Fibre Channel initiator sessions information.  
caching_enabled NsBoolean boolean Indicate caching the volume is enabled. Possible values: 'true', 'false'.  
previously_deduped NsBoolean boolean Indicate whether dedupe has ever been enabled on this volume. Possible values: 'true', 'false'.  
dedupe_enabled NsBoolean boolean Indicate whether dedupe is enabled. Possible values: 'true', 'false'.  
vpd_t10 NsString string The volume's T10 Vendor ID-based identifier. Plain string.  
vpd_ieee0 NsString string The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string. Plain string.  
vpd_ieee1 NsString string The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string. Plain string.  
app_category NsString string Application category that the volume belongs to. Plain string.  
limit_iops NsSignedLong number IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B). Signed 64-bit integer. Example: -1234.  
limit_mbps NsSignedLong number Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B). Signed 64-bit integer. Example: -1234.  
pre_filter NsString string Pre-filtering criteria. Plain string.  
avg_stats_last_5mins NsAverageStats object Average statistics in last 5 minutes. Average statistics.  

JSON Response


            

{
   "data" : {
      "serial_number" : "5596fd1da1c87b8d6c9ce900d3040000",
      "block_size" : 4096,
      "warn_level" : 80,
      "dest_pool_id" : "",
      "pool_id" : "0a00000000000004d3000000000000000000000001",
      "snap_usage_compressed_bytes" : 0,
      "name" : "vol0.762157726640911",
      "last_modified" : 1426776077,
      "snap_usage_populated_bytes" : 0,
      "perfpolicy_id" : "0300000000000004d3000000000000000000000001",
      "num_connections" : 0,
      "description" : "",
      "move_bytes_migrated" : 0,
      "iscsi_sessions" : null,
      "app_uuid" : "",
      "num_fc_connections" : 0,
      "agent_type" : "none",
      "pool_name" : "default",
      "multi_initiator" : false,
      "base_snap_name" : "",
      "size" : 100,
      "perfpolicy_name" : "default",
      "owned_by_group" : "g1a1",
      "snap_limit" : 9223372036854775807,
      "snap_limit_percent" : -1,
      "move_start_time" : 0,
      "encryption_cipher" : "none",
      "total_usage_bytes" : 0,
      "vol_usage_compressed_bytes" : 0,
      "snap_usage_uncompressed_bytes" : 0,
      "snap_reserve" : 0,
      "volcoll_name" : "",
      "projected_num_snaps" : 0,
      "full_name" : "",
      "online" : true,
      "cache_policy" : "normal",
      "vol_state" : "online",
      "num_snaps" : 0,
      "cache_pinned" : false,
      "clone" : false,
      "read_only" : false,
      "reserve" : 0,
      "creation_time" : 1426776077,
      "id" : "0600000000000004d3000000000000000000000005",
      "metadata":[
          {"key":"key1","value":"val1"},
          {"key":"key2","value":"val2"}
      ],
      "caching_enabled" : true,
      "snap_warn_level" : 0,
      "thinly_provisioned" : true,
      "move_aborting" : false,
      "move_bytes_remaining" : 0,
      "fc_sessions" : null,
      "num_iscsi_connections" : 0,
      "offline_reason" : null,
      "pinned_cache_size" : 0,
      "online_snaps" : null,
      "access_control_records" : null,
      "parent_vol_name" : "",
      "cache_needed_for_pin" : 104857600,
      "limit" : 100,
      "target_name" : "iqn.2007-11.com.storage:vol0.762157726640911-v00000000000004d3.00000005.000004d3",
      "volcoll_id" : "",
      "usage_valid" : true,
      "search_name" : "vol0.762157726640911",
      "vol_usage_uncompressed_bytes" : 0,
      "parent_vol_id" : "",
      "base_snap_id" : "",
      "dest_pool_name" : "",
      "upstream_cache_pinned" : false,
      "folder_id": "",
      "folder_name": "",
      "avg_stats_last_5mins": {
        "read_iops": 10,
        "read_throughput": 11,
        "read_latency": 20,
        "write_iops": 25,
        "write_throughput": 90,
        "write_latency": 10,
        "combined_iops": null,
        "combined_throughput": 100,
        "combined_latency": 90
      }
   }
}