Volume情報の取得

GET /volume/{volume_id}

概要説明

指定されたVolumeの情報を取得します。

リクエスト例

Volume ID 250003のVolumeについて、Statusを取得する場合の例です。

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

レスポンス例

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

PATH PARAMETERS

volume_id

(required)

integer

Volume ID。

QUERY PARAMETERS

fields

Array of strings

表示したいParameter。

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

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

Responses

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

RESPONSE BODY

volume_id

integer

Volume ID。

number

integer

Volume Number。

ETERNUS Web GUI またはETERNUS CLIで使われるVolumeの識別子です。

volume_href

string

VolumeのResourceへのLink。

name

string

VolumeのFriendly Name。

status

string

ステータス。

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

detail_status

string

Volumeの詳細ステータス。

項目	説明
Available	正常状態です。
Spare_In_Use	Hot Spare Driveを使用して冗長性を確保している状態です。
Readying	未Format状態です。
Rebuild	故障したDriveから、Hot Spare Driveまたは交換したDriveへのRebuild処理中の状態です。
Copyback	Hot Spare Driveに退避した情報を交換したDriveへ書き戻し中の状態です。
Redundant_Copy	Hot Spare DriveへRedundant Copy中の状態です。
Partially_Exposed_Rebuild	1台目の故障したDriveからHot Spare Driveまたは交換したDriveへのRebuild処理中の状態です (Only for RAID6 or RAID6FR)。
Exposed_Rebuild	2台のDriveに故障が発生中で、1台目の故障したDriveからHost Spare Driveまたは交換したDriveへのRebuild処理中の状態です (Only for RAID6 or RAID6FR)。
Exposed	Drive故障により冗長性を失った状態です。
Partially_Exposed	Driveが1台故障中の状態です (Only for RAID6 or RAID6FR)。
Not_Ready	RAID閉塞状態です。
Broken	故障状態です。
Data_Lost	Dataが失われた状態です。DataのReadもWriteも不可です。

type

string

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の容量拡張時のみ作成されます。

allocated_resource_href

string

Volumeが属するResourceへのLink。

TypeがTPVの場合、Thin Provisioning PoolのLinkを応答します。

TypeがFTVの場合、Flexible Tier PoolのLinkを応答します。

それ以外の場合、RAID GroupのLinkを応答します。

allocated_resource_name

string

Volumeが属するResourceのName。

TypeがTPVの場合、Thin Provisioning PoolのNameを応答します。

TypeがFTVの場合、Flexible Tier PoolのNameを応答します。

それ以外の場合、RAID GroupのNameを応答します。

capacity

integer

Volumeの容量。

単位はMBです。

usage

string

Volumeの用途。

項目	説明
Block	SANで使用するVolumeです。
System	内部制御で使用するVolumeです。
Migration	Non-disruptive Storage Migrationで使用中のVolumeです。
VVOL	Virtual Volumeで使用するVolumeです。
Veeam	Veeam Storage Integrationで使用するVolumeです。
ODX	Offloaded Data Transferで使用するVolumeです。

uid

string

VolumeのUID (Universal Identifier)。

ServerからVolumeを特定するための識別子(Device Name)です。

uid_mode

string

UIDの状態。

項目	説明
Default	Volume作成時のDefaultのUIDが設定されています。
Custom	Volume作成後、UIDが変更されています。
External	Non-disruptive Storage Migrationにより移行元のVolume情報を引き継いでいます。

is_format_in_progress

boolean

Format実行中かどうか。

trueの場合、Formatが実行中です。

is_exc_enabled

boolean

Extreme Cache Poolの対象Volumeかどうか。

trueの場合、Extreme Cache Poolの対象となっています。

is_cm_encryption_enabled

boolean

CMによる暗号化の有無。

trueの場合、Volume内のデータはCMにより暗号化されています。

is_sed_encryption_enabled

boolean

SEDによる暗号化の有無。

trueの場合、Volume内のデータはSEDにより暗号化されています。

is_copy_protection_enabled

boolean

Copy動作保護の対象かどうか。

trueの場合、Copy先Volumeとして使用することができません。

is_used_status_attention

boolean

VolumeのUsed Rateが閾値(attention)を超えているかどうか。

trueの場合、Used Rateが閾値を超えています。

is_deduplication_enabled

boolean

Deduplicationが有効かどうか。

trueの場合、Volumeに書き込まれたデータに対して重複排除が行われます。

is_compression_enabled

boolean

Compressionが有効かどうか。

trueの場合、Volumeに書き込まれたデータに対して圧縮が行われます。

is_thick_provisioned

boolean

Allocation方式がThickがどうか。

trueの場合、Volume作成時に容量分の物理領域が割り当てられています。

Typeが"TPV"または"FTV"の場合に応答します。

used_capacity

integer

Volumeの物理割り当て済み容量。

単位はMBです。

Typeが"TPV"または"FTV"の場合に応答します。

ただし、Data Reduction (Deduplication and/or Compression)の対象Volumeの場合は応答しません。

used_rate

integer

Volumeの使用率。

単位は%です。

Typeが"TPV"または"FTV"の場合に応答します。

ただし、装置異常により情報の取得が失敗した場合は0を応答することがあります。

original_data_size

integer

Volumeに書き込まれたデータ量。

Data Reductionの対象Volumeの場合、削減前のデータ量を意味します。

Data Reduction非対象Volumeの場合、used_capacityに一致します。

Typeが"TPV"または"FTV"の場合に限り応答します。

ただし、System Volumeとして使用されているVolumeの場合は応答しません。

また、装置異常により情報の取得が失敗した場合は0を応答することがあります。

attention

integer

ホストセンスが報告されるUsed Rateの閾値。

単位は%です。

Typeが"TPV"または"FTV"の場合に限り応答します。

ただし、Data Container Volumeの場合は応答しません。

balancing_level

string

Thin Provisioning Poolを構成するRAID Groupの物理割当量の平準化されている度合い。

Typeが"TPV"の場合に限り応答します。

項目	説明
High	均等に物理割り当てされています。
Medium	物理割り当てに若干の偏りがあります。
Low	物理割り当てに大きな偏りがあります。

is_t10dif_enabled

boolean

Volumeのデータ保護形式。

trueの場合、T10-DIFに準拠したデータ保護が有効です。

alua

string

ALUA (Asymmetric Logical Unit Access) 設定。

Mappingが作成できないVolume (UsageがSystem, VVOL or ODXのVolume, SDPV, Temporary Volume) の場合は応答しません。

項目	説明
Follow_Host_Response	Host Response設定に従います。
ACTIVE_ACTIVE	ACTIVE/ACTIVE応答します。
ACTIVE-ACTIVE_PREFERRED_PATH	ACTIVE-ACTIVE/PREFERRED PATH応答します。

is_connected

boolean

Volumeに接続中のHostが存在するかどうか。

trueの場合、接続中のHostが存在します（該当VolumeがLUN Groupに所属している場合、trueになります）。

falseの場合、接続中のHostは存在しません（該当VolumeがLUN Groupに所属していない場合、falseになります）。