15.2　特定のスナップショットグループの情報を取得する

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/simple/v1/objects/snapshot-groups/＜オブジェクトID＞

リクエストメッセージ

オブジェクトID

スナップショットグループ名の一覧取得で取得したnameの値を指定します。

属性	型	説明
name	string	（必須）スナップショットグループ名

メモ

次に示すスナップショットグループ名は指定できません。

• スラッシュまたはバックスラッシュを含むスナップショットグループ名

• ピリオド（.）のみのスナップショットグループ名

該当のスナップショットグループの情報を取得する場合は、クエリパラメータsnapshotGroupNameを指定して、スナップショットの情報を取得するAPIを実行することでスナップショットグループの情報が取得できます。

クエリパラメータ

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（ミラーユニット）番号が出力されます。
count	int	スナップショットの情報の格納数
totalCount	int	スナップショットグループ内のスナップショット総数
hasNext	boolean	取得できていない情報があるかどうかが出力されます。 true：取得できていない情報がある false：すべての情報が取得できている 取得できていない情報がある場合、クエリパラメータを指定して取得する情報をフィルタリングするか、取得できている情報のうち、最大のスナップショットのID以降を複数回に分けてAPIを実行し取得してください。

ステータスコード

この操作のリクエストに対するステータスコードについては、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