16.1 外部ボリュームの情報を取得する
外部ボリュームに関する情報を取得します。外部ボリュームの条件を指定して、絞り込んだ情報を取得することもできます。
- メモ
-
- 外部パリティグループ:外部接続したストレージシステムのボリュームをマッピングして作成されたパリティグループです。外部ボリュームを管理するために使用します。
- 外部ボリューム:外部パリティグループから作成されたボリュームです。
- 外部パスグループ:外部接続用ポートと、外部ストレージシステムのポート間を接続した経路のことを外部パスと呼びます。同じ外部パスを使用する外部ボリュームをグルーピングしたものを外部パスグループと呼びます。
実行権限
ストレージ管理者(参照)
リクエストライン
GET <ベースURL>/simple/v1/objects/external-volumes
リクエストメッセージ
- オブジェクトID
- なし。
- クエリパラメータ
-
1回のリクエストで取得できる外部ボリュームの情報は最大で200個です。201個以上の外部ボリュームの情報を取得する場合は、countパラメータとstartVolumeIdパラメータを組み合わせて複数回に分けてAPIを実行してください。countパラメータを指定することで取得する外部ボリュームの情報をフィルタリングすることもできます。
パラメータ
型
フィルタ条件
nickname
string
(任意)外部ボリュームのニックネーム
指定した値の一部が外部ボリュームのニックネームと一致する場合も外部ボリュームの情報が取得されます。
minTotalCapacity
long
(任意)外部ボリュームの最小容量(MiB)
取得する外部ボリュームの最小容量として47~268435456までの整数で指定します。
maxTotalCapacity
long
(任意)外部ボリュームの最大容量(MiB)
取得する外部ボリュームの最大容量として47~268435456までの整数で指定します。
status
string
(任意)取得する外部ボリュームの状態として、次の値を指定します。
- Normal:正常
- Blockade:閉塞
volumeType
string
(任意)取得する外部ボリュームタイプとして、Quorum Disk(global-active deviceで使用するQuorumディスク)を指定します。
externalParityGroupId
string
(任意)外部パリティグループID
「X-Y」形式で指定します。
Xに指定できる値は1~16384までの整数です。
Yに指定できる値は1~4096までの整数です。
externalPathGroupId
int
(任意)外部パスグループIDを0~63231までの整数で指定します。
startVolumeId
int
(任意)取得を開始する外部ボリュームのIDを0~65279の値で指定します。
count
int
(任意)取得する外部ボリュームの情報の個数を1~200の値で指定します。
このパラメータを省略した場合、200が指定されたと見なされます。
- ボディ
- なし。
レスポンスメッセージ
- ボディ
-
外部ボリュームタイプがQuorumディスク(クエリパラメータvolumeTypeにQuorum Diskを指定)の外部ボリュームの情報を取得した出力例を次に示します。
{ "data": [ { "id": 1655, "nickname": "externalVolumeFc", "totalCapacity": 16384, "Status": "Normal", "externalParityGroupId": "42-3", "externalPathGroupId": 91, "externalPathOfVolume": [ { "portId": "CL5-A", "portProtocol": "FC", "externalPortWwn": "50060e8012000c60", "lun": 1463 } ], "volumeTypes": [ "Quorum Disk" ], "externalStorage": { "model": "VSP Gx00", "serial": "400012", "vendor": "HITACHI" }, "quorumSetting": { "quorumId": 31, "pairedStorageModel": "M8", "pairedStorageSerial": "401026" } }, { "id": 1656, "nickname": "externalVolumeIscsi", "totalCapacity": 16384, "status": "Normal", "externalParityGroupId": "9-1025", "externalPathGroupId": 1025, "externalPathOfVolume": [ { "portId": "CL1-B", "portProtocol": "iSCSI", "externalPortIpAddress": "10.1.2.122", "externalPortIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8m.t.00012.2d00b", "externalTcpPortNumber": 3260, "lun": 1025, "virtualPortNumber": 1 } ], "volumeTypes": [ "Quorum Disk" ], "externalStorage": { "model": "VSP Gx00", "serial": "400012", "vendor": "HITACHI" }, "quorumSetting": { "quorumId": 12, "pairedStorageModel": "M8", "pairedStorageSerial": "401206" } } ], "count": 2, "totalCount": 2, "hasNext": false }
属性
型
説明
id
int
外部ボリュームID
nickname
string
外部ボリュームのニックネーム
外部ボリュームのニックネームが定義されている場合に出力されます。
totalCapacity
long
外部ボリュームの総容量(MiB)
status
string
外部ボリュームの状態
- Normal:正常
- Busy:状態遷移中
- Blockade:閉塞
externalParityGroupId
string
外部パリティグループID
externalPathGroupId
int
外部パスグループID
externalPathOfVolume
object[]
外部ボリュームの外部パス情報が、外部パスごとに出力されます。
- portId(string)
外部接続用のポートID
- portProtocol(string)
ポートのプロトコル
- FC
- iSCSI
- externalPortWwn(string)
外部ストレージシステムのポートのWWN
iSCSIポートの場合、この属性は出力されません。
- externalPortIpAddress(string)
外部ストレージシステムのポートのIPアドレス
IPv4またはIPv6形式で出力されます。
FCポートの場合、この属性は出力されません。
- externalPortIscsiName(string)
外部ストレージシステムのポートのiSCSIターゲット名
FCポートの場合、この属性は出力されません。
- externalTcpPortNumber(int)
外部ストレージシステムのポートのTCPポート番号
FCポートの場合、この属性は出力されません。
- virtualPortNumber(int)
外部接続用のポートの仮想ポート番号
次の場合、この属性は出力されません。
- FCポートの場合
- iSCSIポートの場合で、仮想ポートが無効のとき
- lun(int)
外部ストレージシステムのポートに割り当てられているLUN
volumeTypes
object[]
外部ボリュームタイプ
- Quorum Disk:global-active deviceで使用するQuorumディスク
externalStorage
object
外部ストレージシステムの情報が出力されます。
- model(string)
外部ストレージシステムのモデル
出力される外部ストレージシステムの表記については、マニュアルUniversal Volume Managerユーザガイドを参照してください。
有効な値が取得できない場合、この属性は出力されません。
- serial(string)
外部ストレージシステムのシリアル番号
有効な値が取得できない場合、この属性は出力されません。
- vendor(string)
外部ストレージシステムのベンダー識別子
有効な値が取得できない場合、この属性は出力されません。
quorumSetting
object
Quorumディスクに関する情報が設定されている場合に、Quorumディスクに関する情報が出力されます。
- quorumId(int)
QuorumディスクID
- pairedStorageModel(string)
Quorumディスクを共有する相手側のストレージシステムのモデル
- R8:VSP G1000、VSP G1500、またはVSP F1500
- R9:VSP 5000 シリーズ
- M8:VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900、VSP G200、G400、G600、G800、VSP F400、F600、F800
モデルの情報が取得できない場合、Unknownが出力されます。
- pairedStorageSerial(string)
Quorumディスクを共有する相手側のストレージシステムのシリアル番号
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/external-volumes?volumeType="Quorum Disk"