13.3　スナップショットの情報を取得する : Hitachi Storage Advisor Embedded ガイド

実行権限

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

リクエストライン

GET ＜ベースURL＞/simple/v1/objects/snapshots

リクエストメッセージ

オブジェクトID: なし。

クエリパラメータ

1回のリクエストで取得できるスナップショットの情報は最大で1000個です。1001個以上のスナップショットの情報を取得する場合は、countパラメータとstartIdパラメータを組み合わせて複数回に分けてAPIを実行してください。countパラメータを指定することで取得するボリュームの情報をフィルタリングすることもできます。

パラメータ	型	フィルタ条件
masterVolumeId	int	（任意）スナップショットの作成元ボリュームID
snapshotDateFrom	string	（任意）取得するスナップショットの日時をYYYY-MM-DDThh:mm:ssZ形式で指定します。このパラメータで指定された日時以降のスナップショットの情報を取得します。
snapshotDateTo	string	（任意）取得するスナップショットの日時をYYYY-MM-DDThh:mm:ssZ形式で指定します。このパラメータで指定された日時以前のスナップショットの情報を取得します。
snapshotGroupName	string	（任意）スナップショットグループ名指定した値と完全に一致するスナップショットの情報が取得されます。
startId	string	（任意）取得を開始するスナップショットの情報を、スナップショットの作成元ボリュームIDとスナップショットIDをコンマで連結した形式で指定します。 `<masterVolumeId>,<snapshotId>` このパラメータを省略した場合、`"0,0"`が指定されたと見なされます。
count	int	（任意）取得するスナップショットの情報の個数を`1`～`1000`の値で指定します。このパラメータを省略した場合、`1000`が指定されたと見なされます。

ボディ: なし。

レスポンスメッセージ

ボディ

{
  "data": [
    {
      "id": "100,3",
      "masterVolumeId": 100,
      "snapshotId": 3,
      "status": "Completed",
      "snapshotDate": "2015-03-20T09:27:35Z",
      "snapshotGroupName": "snapshotGroup",
      "rootVolumeId": 100,
      "poolId": 10,
      "usedCapacityPerRootVolume": 126,
    },
    {
      "id": "100,4",
      "masterVolumeId": 100,
      "snapshotId": 4,
      "status": "Completed",
      "snapshotDate": "2015-03-20T09:27:35Z",
      "snapshotGroupName": "snapshotGroup",
      "rootVolumeId": 100,
      "poolId": 10,
      "usedCapacityPerRootVolume": 126,
    },
  ],
  "count": 2,
  "totalCount": 2,
  "hasNext": false
}

属性	型	説明
id	string	スナップショットの作成元ボリュームID、およびスナップショットIDがコンマで連結した形式で出力されます。
masterVolumeId	int	スナップショットの作成元ボリュームID
snapshotId	int	スナップショットID MU（ミラーユニット）番号が出力されます。
status	string	スナップショットの状態 `Creating`：スナップショット作成中 `In Sync`：スナップショット同期処理完了 `Completed`：スナップショット作成済 `Deleting`：スナップショット削除中 `Restoring`：スナップショットリストア中 `Preparing`：クローン準備中 `Clone Ready`：クローン準備完了 `Cloning`：クローン実行中 `Removing`：クローン設定解除中 `Error`：障害が発生している
snapshotDate	string	スナップショットの作成日時
snapshotGroupName	string	スナップショットグループ名
mappedVolumeId	int	スナップショットの作成先ボリュームID スナップショットの作成先ボリュームIDが定義されている場合に出力されます。
rootVolumeId	int	スナップショットのルートボリュームID
poolId	int	スナップショットの差分データが格納されているプールのプールID
usedCapacityPerRootVolume	long	スナップショットの差分データが格納されているプールにおいてスナップショット群が使用している差分情報と制御情報の総容量（MiB）

ステータスコード

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

13.3 スナップショットの情報を取得する

13.3　スナップショットの情報を取得する