全Volume情報の取得

概要説明

Volume情報を取得します。

Volume Numberの昇順で表示します。

リクエスト例

Volume Number 0 のVolumeから10個分のVolumeについて、Volume IDとStatusを取得する場合の例です。

$ 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"

正常状態のVolumeについて、Volume IDとNameを取得する場合の例です。

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

レスポンス例

{
  "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。

指定したParameter名(Response Body Parameter)の情報のみを抜き出して取得します。

指定方法の詳細は、表示する項目の絞り込みを参照してください。

volume_id

Array of integers

Volume ID。

情報を取得したいVolumeのIDを指定します。

入力条件：

256個まで指定可能です。

tpp_id

Array of integers

Thin Provisioning Pool ID。

情報を取得したいThin Provisioning PoolのIDを指定します。

入力条件：

256個まで指定可能です。

raidgroup_id

Array of integers

RAID Group ID。

情報を取得したいRAID GroupのIDを指定します。

入力条件：

256個まで指定可能です。

status

Array of strings

ステータス。

情報を取得したいリソースのステータスを指定します。

項目	説明
Normal	正常状態です。
Maintenance	保守状態です。
Warning	予防保守が必要な状態です。
Error	異常が発生し、保守が必要な状態です。

入力条件：

4個まで指定可能です。

type

Array of strings

Volume Type。

項目	説明
Standard	RAID GroupまたはExternal RAID Groupに作成されるVolumeです。
TPV	Thin Provisioning Volume。Thin Provisioning Poolに作成されるVolumeです。
FTV	Flexible Tier Volume。Flexible Tier Poolに作成されるVolumeです。Automated Storage Tieringによるストレージ自動階層制御の対象となります。
WSV	Wide Striping Volume。複数のRAID Groupに分散してDataを配置するVolumeです。
SDV	Snap Data Volume。SnapOPCまたはSnapOPC+のCopy先として使用できるVolumeです。
SDPV	Snap Data Pool Volume。Snap Data Poolを構成するVolumeです。
Temporary	一時的に作成される作業用Volume。Standard Volumeの容量拡張時のみ作成されます。

入力条件：

7個まで指定可能です。

is_used_status_attention

boolean

Used StatusがAttentionかどうか。

trueを指定した場合、Used StatusがAttentionのVolumeのみの情報を取得します。

max_records

integer

情報を取得したいリソースの最大数。

応答する情報数を制限したい場合に指定してください。

入力条件：

指定可能な範囲は1～512です。

start_number

integer

Default: 0

情報を取得したいリソースの先頭のNumber。

last_get_id

integer

続きの情報を取得するためのリソースの識別子。

一度に応答条件に合致するすべてのリソースを応答できなかった場合、next_hrefが返却されます。

last_get_idはnext_hrefに付与される、続きの情報を取得するための情報です。

Responses

正常に取得できた場合、HTTPステータスコードが200 (OK)となりレスポンスボディを応答します。

RESPONSE BODY

total_count	integer 装置に存在するResourceの総数。フィルタリングしている場合は、条件に合致するResourceの総数です。
list_count	integer 応答するListの個数。
volume_list	Array of objects GET /volume/volume_idで取得できる情報を、list_count数分出力します。詳細は、Volume情報の取得の「Responses」を参照してください。
next_href	string 続きの情報を取得するためのLink。一度にすべての情報を応答しきることができなかった場合に限り応答します。例えば、max_recordsで指定した個数以上に応答条件に合致するResourceが存在する場合などに応答します。