11.4 スナップショットグループ単位でThin Imageペアの情報を取得する
実行権限
ストレージ管理者(参照)
リクエストライン
GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/snapshot-groups
リクエストメッセージ
- オブジェクトID
-
なし。
- クエリパラメータ
-
スナップショットグループ内のペア情報の一覧を取得したり、スナップショットグループ内のペアの詳細な情報を取得したりできます。
パラメータ
型
説明
snapshotGroupName
string
(任意)Thin Imageペアが所属するスナップショットグループ名称
1~32文字で指定します。
対象のスナップショットグループ内のペア情報の一覧を取得します。
省略した場合は、スナップショットグループの一覧を取得します。
このパラメータは、detailInfoTypeパラメータとは同時に指定できません。
detailInfoType
string
(任意)取得する詳細情報のタイプ
- pair
スナップショットグループの一覧に加えて、対象のスナップショットグループ内のペアの詳細な情報を取得します。
ストレージシステムがVSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデル、VSP F1500の場合に指定できます。VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合、SVP と連携する構成のときに指定できます。
最新の情報を取得する場合、事前にストレージシステムの構成情報のキャッシュを更新するAPIを実行する必要があります。詳細については、「ストレージシステムの構成情報のキャッシュを更新する」の説明を参照してください。
このパラメータは、snapshotGroupNameパラメータとは同時に指定できません。
- pair
- ボディ
-
なし。
レスポンスメッセージ
- ボディ
-
スナップショットグループ一覧を取得した場合の出力例を次に示します。
{ "data": [ { "snapshotGroupName": "snapshotGroup", "snapshotGroupId": "snapshotGroup" }, { "snapshotGroupName": "snapshotGroup2", "snapshotGroupId": "snapshotGroup2" } ] }属性
型
説明
snapshotGroupName
string
Thin Imageペアが所属するスナップショットグループ名称
スナップショットグループ名称に半角スペースが含まれている場合、そのスナップショットグループの情報を取得できません。
snapshotGroupId
string
スナップショットグループのオブジェクトID
クエリパラメータにsnapshotGroupNameを指定して、スナップショットグループ内のペア情報の一覧を取得した場合の出力例を次に示します。ペアが複数ある場合、プライマリボリュームのLDEV番号およびMU番号の昇順で出力されます。
{ "data": [ { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 3, "svolLdevId": 101, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,3", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false }, { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 4, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,4", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false } ] }属性
型
説明
snapshotGroupName
string
Thin Imageペアが所属するスナップショットグループ名称
スナップショットグループ名称に半角スペースが含まれている場合、ペアの情報を取得できません。
primaryOrSecondary
string
対象となるLDEVの属性
status
string
ペアの状態
詳細については、ペアの状態遷移(Thin Image)の説明を参照してください。
pvolLdevId
int
P-VOLのLDEV番号
muNumber
int
P-VOLのMU番号
svolLdevId
int
S-VOLのLDEV番号
snapshotPoolId
int
スナップショットデータが作成されているプールID
concordanceRate
int
ペアの一致率
次のどれかの条件が該当する場合に表示されます。
- isClone属性がfalse、かつcanCascade属性がfalse
- isClone属性がtrue、かつstatus属性がCOPY、RCPY、SMPP、PSUPのどれでもない
- canCascade属性がtrue、かつstatus属性がCOPY、RCPY、SMPP、PSUPのどれでもない
progressRate
int
処理の進捗率
次のどちらかの条件を満たす場合に表示されます。
- isClone属性がtrue、かつstatus属性がCOPY、RCPY、SMPP、PSUPのどれか
- canCascade属性がtrue、かつstatus属性がCOPY、RCPY、SMPP、PSUPのどれか
isConsistencyGroup
boolean
ペアがコンシステンシーグループモード(CTGモード)で作成されたかどうかが表示されます。
- true:CTGモードで作成されている
- false:CTGモードで作成されていない
isWrittenInSvol
boolean
ペアの状態がPSUS/PFUSのとき、ホストからS-VOLへデータ書き込みがあったかどうかが表示されます。
- true:S-VOLへの書き込みあり
- false:S-VOLへの書き込みなし
S-VOLなしのThin Imageペアの場合はfalseが表示されます。
isClone
boolean
クローン属性のペアかどうかが表示されます。
- true:クローン属性のペア
- false:クローン属性でないペア
canCascade
boolean
ペアをカスケード構成にできるかどうかが表示されます。
- true:カスケード構成にできる
- false:カスケード構成にできない
splitTime
string
スナップショットデータの作成時刻
YYYY-MM-DDThh:mm:ss形式でストレージシステムのローカルタイムが表示されます。
VSP G1000、VSP G1500、VSP F1500、Virtual Storage Platform、またはHUS VMで、外部認証サーバまたは鍵管理サーバを使用するための設定を保守員に依頼している場合、ストレージシステムのタイムゾーンの設定が変更されていることがあります。この場合、グリニッジ標準時(GMT)が表示されます。
snapshotId
string
Thin ImageペアのオブジェクトID
次の属性をコンマで連結した形式で表示されます。- pvolLdevId
- muNumber
pvolProcessingStatus
string
ペアに対する処理の状態
- E:拡張処理が実行中
- N:拡張処理が実行中でない
VSP 5000 シリーズ、VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP G1000、VSP G1500、VSP F350、F370、F700、F900、VSP F1500の場合、かつprimaryOrSecondary属性がP-VOLのときに出力されます。
svolProcessingStatus
string
ペアに対する処理の状態
- E:拡張処理が実行中
- N:拡張処理が実行中でない
VSP 5000 シリーズ、VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP G1000、VSP G1500、VSP F350、F370、F700、F900、VSP F1500の場合、かつprimaryOrSecondary属性がS-VOLのときに出力されます。
snapshotDataReadOnly
boolean
スナップショットデータが読み取り専用属性のペアかどうか出力されます。
- true:読み取り専用
- false:読み取り専用ではない
VSP 5000 シリーズ、VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合に出力されます。
クエリパラメータでdetailInfoTypeにpairを指定して実行すると、スナップショットグループの一覧に加えて次の情報も取得できます。ペアが複数ある場合、プライマリボリュームのLDEV番号およびMU番号の昇順で出力されます。
属性
型
説明
snapshots
object[]
スナップショットグループに含まれるThin Imageペアに関する、次の属性が出力されます。
- snapshotGroupName(string)
スナップショットグループの名称
- status(string)
ペアの状態
詳細については、ペアの状態遷移(Thin Image)の説明を参照してください。
- pvolLdevId(int)
P-VOLのLDEV番号
- muNumber(int)
P-VOLのMU番号
- svolLdevId(int)
S-VOLのLDEV番号
対象のペアがS-VOLありのThin Imageペアの場合に表示されます。
- snapshotPoolId(int)
スナップショットデータが作成されているプールID
- concordanceRate(int)
ペアの一致率
ペアの状態がSMPL以外の場合に表示されます。
- isConsistencyGroup(boolean)
ペアがコンシステンシーグループモード(CTGモード)で作成されたかどうかが表示されます。
- true:CTGモードで作成されている
- false:CTGモードで作成されていない
- isWrittenInSvol(boolean)
ペアの状態がPSUS/PFUSのとき、ホストからS-VOLへデータ書き込みがあったかどうかが表示されます。
- true:S-VOLへの書き込みあり
- false:S-VOLへの書き込みなし
S-VOLなしのThin Imageペアの場合はfalseが表示されます。
- isClone(boolean)
クローン属性のペアかどうかが表示されます。
- true:クローン属性のペア
- false:クローン属性でないペア
- canCascade(boolean)
ペアをカスケード構成にできるかどうかが表示されます。
- true:カスケード構成にできる
- false:カスケード構成にできない
- splitTime(string)
スナップショットデータの作成時刻
ペアの状態がPSUS、PFUS、PSUPの場合に表示されます。
YYYY-MM-DDThh:mm:ss形式で、ストレージシステムのグリニッジ標準時(GMT)が表示されます。
- snapshotId(string)
Thin ImageペアのオブジェクトID
次の属性をコンマで連結した形式で表示されます。
- pvolLdevId
- muNumber
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept: application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/snapshot-groups