16.10 外部パスグループの一覧を取得する
取得するリソース数によっては、1回のリクエストですべての情報を取得できない場合があります。その場合、レスポンスボディのnextPageHeadPathGroupIdには、取得できなかった情報に含まれる外部パスグループのうち、先頭のパスグループIDが返ります。取り残した情報を取得するには、そのパスグループIDをクエリのheadPathGroupIdパラメータに指定してAPIを実行します。対象の情報がすべて取得できている場合、nextPageHeadPathGroupIdには-1が返ります。
- 重要
-
外部パスグループの一覧を取得するAPIは、ファイバーチャネルポートの場合だけ使用できます。iSCSIポートの場合は使用できません。
iSCSIポートの場合でローカルストレージシステムがVSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900のときは、Hitachi Storage Advisor Embeddedガイドに記載されているREST APIを使用してください。上記以外の機種のときは、RAID Managerなどのストレージ管理ソフトウェアを使用してください。
実行権限
ストレージ管理者(参照)
リクエストライン
GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/external-path-groups
リクエストメッセージ
- オブジェクトID
- なし。
- クエリパラメータ
-
パラメータ
型
フィルタ条件
externalParityGroupId
string
(任意)外部パリティグループ番号
<gno>-<sgno>形式で指定します。
ldevId パラメータと同時に指定できません。
ldevId
string
(任意)LDEV番号
externalParityGroupIdパラメータと同時に指定できません。
headPathGroupId
int
(任意)取得する外部パスグループの先頭の外部パスグループ番号
外部パスグループを範囲指定して取得する場合は、このパラメータで先頭の外部パスグループ番号を指定します。
- ボディ
-
なし。
レスポンスメッセージ
- ボディ
-
{ "data": [ { "externalPathGroupId": 0, "externalSerialNumber": "91110309", "externalProductId": "HUS", "externalParityGroups": [ { "externalParityGroupId": "1-1", "externalParityGroupStatus": "BLK", "cacheMode": "D", "isInflowControlEnabled": false, "mpBladeId": 0, "loadBalanceMode": "N", "pathMode": "M", "isDataDirectMapping": false, "externalLuns": [ { "portId": "CL5-B", "externalWwn": "50060e8010539b51", "priority": 1, "externalLun": 0, "pathStatus": "BLK" } ] }, { "externalParityGroupId": "1-12", "externalParityGroupStatus": "BLK", "cacheMode": "E", "isInflowControlEnabled": false, "mpBladeId": 2, "loadBalanceMode": "N", "pathMode": "M", "isDataDirectMapping": false, "externalLuns": [ { "portId": "CL5-B", "externalWwn": "50060e8010539b51", "priority": 1, "externalLun": 19, "pathStatus": "BLK" } ] } ], "externalPaths": [ { "portId": "CL5-B", "externalWwn": "50060e8010539b51" } ], "nextPageHeadPathGroupId": -1 }, { "externalPathGroupId": 1, "externalSerialNumber": "210945", "externalProductId": "HUS VM", "externalParityGroups": [ { "externalParityGroupId": "1-2", "externalParityGroupStatus": "NML", "cacheMode": "D", "isInflowControlEnabled": false, "mpBladeId": 1, "loadBalanceMode": "N", "pathMode": "M", "isDataDirectMapping": false, "externalLuns": [ { "portId": "CL5-B", "externalWwn": "50060e80132ac120", "priority": 1, "externalLun": 21, "pathStatus": "NML" } ] }, { "externalParityGroupId": "1-23", "externalParityGroupStatus": "NML", "cacheMode": "E", "isInflowControlEnabled": false, "mpBladeId": 2, "loadBalanceMode": "N", "pathMode": "M", "isDataDirectMapping": false, "externalLuns": [ { "portId": "CL5-B", "externalWwn": "50060e80132ac120", "priority": 1, "externalLun": 32, "pathStatus": "NML" } ] } ], "externalPaths": [ { "portId": "CL5-B", "externalWwn": "50060e80132ac120" } ], "nextPageHeadPathGroupId": -1 } ] }
属性
型
説明
externalPathGroupId
int
外部パスグループ番号
externalSerialNumber
string
外部ストレージシステムのシリアル番号
externalProductId
string
外部ストレージシステムのプロダクトID
externalParityGroups
object[]
外部パリティグループごとに次の属性が出力されます。
- externalParityGroupId(string)
外部パリティグループ番号
- externalParityGroupStatus(string)
外部パリティグループの状態
-
NML:正常状態
-
CHK:マッピングパスの状態を確認中
-
SYN:キャッシュ内のデータをボリュームに書き込み中
-
DSC:外部ストレージシステムまたは外部ボリュームへの接続を停止した状態
-
BLK:マッピングパスが閉塞状態
-
WAR:マッピングパスの状態が正常でない状態
-
Unknown:不明状態
-
- cacheMode(string)
キャッシュモード
-
E:有効
-
D:無効
-
EM:有効
-
DM:無効
-
TM:スルー
-
SM:同期書き込み
-
- isInflowControlEnabled(boolean)
キャッシュ流入制御
-
true:有効
-
false:無効
-
- mpBladeId(int)
MPブレードID
- loadBalanceMode(string)外部ストレージシステムへのI/Oの負荷分散方式
-
N:標準ラウンドロビン方式
-
E:拡張ラウンドロビン方式
-
D:負荷分散を実行せず、1 つのパスでI/Oを実行
-
- pathMode(string)
外部ストレージシステム側のパスモード
-
M:Multiモード
-
S:Singleモード
-
A:APLBモード
-
AL:ALUAモード
-
MA:Multiモード(ALUAモードに変更可能な状態)
-
SA:Singleモード(ALUAモードに変更可能な状態)
-
- isDataDirectMapping(boolean)
データダイレクトマップ属性が有効かどうか
-
true:有効
-
false:無効
-
- externalLuns(object[])
外部ストレージシステムのLUごとに次の属性が出力されます。
- portId(string)
ポート番号
- externalWwn(string)
外部ストレージシステム側のWWN
- priority(int)
外部パスグループ内での優先順位
- externalLun(int)
外部ストレージシステム側のポート内のLUN
- pathStatus(string)
外部パスの状態
NML:正常状態
CHK:一時閉塞している状態(外部パスの状態を確認中)
BLK:閉塞状態
DSC:接続が停止している状態
Unknown:不明状態
- portId(string)
externalPaths
object[]
外部パスごとに次の属性が出力されます。
- portId(string)
ポート番号
- externalWwn(string)
外部ストレージシステム側のWWN
- qDepth(int)
外部パリティグループに対して1度に発行できるRead/Writeコマンドの数
qDepth属性に値が設定されている場合だけ取得されます。
- ioTimeOut(int)
外部パリティグループへのI/Oタイムオーバーの設定値(秒)
ioTimeOut属性に値が設定されている場合だけ取得されます。
- blockedPathMonitoring(int)
外部パリティグループへのすべてのパスの接続が切断されてから、外部パリティグループが閉塞するまでの時間(秒)
blockedPathMonitoring属性に値が設定されている場合だけ取得されます。
nextPageHeadPathGroupId
int
取得できなかった情報に含まれる外部パスグループのうち、先頭のパスグループID
1度のリクエストですべての外部パスグループ情報を取得できなかった場合、クエリでheadPathGroupIdパラメータにこの値を指定してAPIを実行すると、取り残した情報を取得できます。
すべての情報が取得できている場合は-1が出力されます。
- externalParityGroupId(string)
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/886000123457/external-path-groups