13.2 特定のスナップショットグループの情報を取得する
スナップショットグループ名を指定して、スナップショットグループの情報を取得します。
実行権限
ストレージ管理者(参照)
リクエストライン
GET <ベースURL>/simple/v1/objects/snapshot-groups/<オブジェクトID>
リクエストメッセージ
- オブジェクトID
- スナップショットグループ名の一覧取得で取得したnameの値を指定します。
-
属性
型
説明
name
string
(必須)スナップショットグループ名
- クエリパラメータ
- 1回のリクエストで取得できるスナップショットグループの情報は最大で1000個です。1001個以上のスナップショットグループの情報を取得する場合は、countパラメータとstartSnapshotIdパラメータを組み合わせて複数回に分けてAPIを実行してください。countパラメータを指定することで取得するボリュームの情報をフィルタリングすることもできます。
-
パラメータ
型
フィルタ条件
startSnapshotId
string
(任意)取得を開始するスナップショットのIDを指定します。
このパラメータを省略した場合、"0,0"が指定されたと見なされます。
count
int
(任意)取得するスナップショットグループの情報の個数を1~1000の値で指定します。
このパラメータを省略した場合、1000が指定されたと見なされます。
- ボディ
- なし。
レスポンスメッセージ
- ボディ
- スナップショットグループ名がsnapshotGroupのスナップショットグループの情報を取得した出力例を次に示します。
-
{ "name": "snapshotGroup", "snapshots": [ { "masterVolumeId": 100, "snapshotId": 3 }, { "masterVolumeId": 100, "snapshotId": 4 } ], "count": 2, "totalCount": 2, "hasNext": false }
-
属性
型
説明
name
string
スナップショットグループ名
snapshots
object[]
スナップショットに関する情報が出力されます。
- masterVolumeId(int)
スナップショットの作成元ボリュームID
- snapshotId(int)
スナップショットID
MU(ミラーユニット)番号が出力されます。
- masterVolumeId(int)
ステータスコード
この操作のリクエストに対するステータスコードについては、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/snapshot-groups/snapshotGroup