Obtaining All the Volume Information

Introduction

Obtains the Volume information.

The list is sorted by Volume Number in ascending order.

Request Examples

This is an example of obtaining the Volume ID and Status for 10 Volumes from a Volume Number of 0.

$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/volume?start_number=0&max_records=10&fields=status"

This is an example of obtaining the Volume ID and Name for a healthy Volume.

$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/volume?status=Normal&fields=name"

Response Examples

{
  "total_count": 512,
  "list_count": 1,
  "volume_list": [
    {
      "volume_id": 100001,
      "number": 1,
      "volume_href": "/api/v1/volume/100001",
      "name": "sample_vol#0",
      "status": "Normal",
      "detail_status": "Available",
      "type": "Standard",
      "allocated_resource_href": "/api/v1/tpp/0",
      "capacity": 10240,
      "usage": "Block",
      "uid": "600000e00d3100000031000000140000",
      "uid_mode": "Default",
      "is_format_in_progress": true,
      "is_exc_enabled": true,
      "is_cm_encryption_enabled": false,
      "is_sed_encryption_enabled": false,
      "is_copy_protection_enabled": true,
      "is_used_status_attention": false,
      "is_deduplication_enabled": true,
      "is_compression_enabled": true,
      "is_thick_provisioned": true,
      "used_capacity": 1024,
      "used_rate": 33,
      "original_data_size": 2023,
      "attention": 80,
      "balancing_level": "High",
      "is_t10dif_enabled": false,
      "alua": "Follow_Host_Response"
    }
  ]
}

Parameters

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and obtained.

For details about the specification methods, see Property Filter.

volume_id

Array of integers

Volume ID.

Specify the Volume ID for which you want information.

Input criteria:

You can specify up to 256 values.

tpp_id

Array of integers

Thin Provisioning Pool ID.

Specify the ID of the Thin Provisioning Pool for which you want information.

Input criteria:

You can specify up to 256 values.

raidgroup_id

Array of integers

RAID Group ID.

Specify the ID of the RAID Group for which you want information.

Input criteria:

You can specify up to 256 values.

status

Array of strings

Status.

Specify the status of the resource for which you want information.

Item	Description
Normal	Normal state.
Maintenance	Maintenance state.
Warning	Preventive maintenance is required.
Error	An error has occurred and maintenance is required.

Input criteria:

You can specify up to 4 values.

type

Array of strings

Volume Type.

Item	Description
Standard	A Volume that is created in a RAID Group or External RAID Group.
TPV	Thin Provisioning Volume. A Volume that is created in the Thin Provisioning Pool.
FTV	Flexible Tier Volume. A Volume that is created in the Thin Provisioning Pool. This volume type is a target for Automated Storage Tiering.
WSV	Wide Striping Volume. A Volume that distributes Data across RAID Groups.
SDV	Snap Data Volume. A Volume that can be used as a SnapOPC or SnapOPC+ copy destination.
SDPV	Snap Data Pool Volume. The Volumes that make up the Snap Data Pool.
Temporary	A temporary, working volume. Created only when you expand the capacity of a Standard Volume.

Input criteria:

You can specify up to 7 values.

is_used_status_attention

boolean

Whether the Used Status is Attention.

If true, only the information of the Volumes with a Used Status of Attention is obtained.

max_records

integer

The maximum number of resources for which you want information.

Specify this parameter when you want to limit the number of pieces of information that can be answered.

Input criteria:

The range of allowed values is 1 to 512.

start_number

integer

Default: 0

The first number of the resource for which you want information.

last_get_id

integer

The identifier of the resource for which to obtain further information.

If all resources matching the response conditions cannot be answered at once, next_href is returned.

The last_get_id is the information given to next_href to obtain further information.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

total_count	integer The total number of Resources present in the device. If a filter is applied, this is the total number of Resources that meet the criteria.
list_count	integer Number of Lists to respond.
volume_list	Array of objects The information that can be obtained with GET /volume/volume_id as the number specified for list_count is output. For more information, see "Responses" in Obtaining Volume Information.
next_href	string Link to get more information. This item is returned only when it is not possible to respond all information at once. For example, this item is returned if there are more Resources that match the response condition than the number specified by max_records.