List accessible snapshots#

スナップショットの概要を一覧表示します。

APIエンドポイント#

リージョン	APIエンドポイント
西日本リージョン3の場合	https://blockstorage.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合	https://blockstorage.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v3/{project_id}/snapshots

HTTPステータスコード#

正常時：200

エラー時：400

リクエストパラメータの説明#

名前	In	Type	デフォルト値 /必須指定	Description
project_id	path	string	必須	プロジェクトのUUID
sort	query	string	任意	ソートキーと任意のソート指示のリスト以下の形式で、コンマ(,)で区切られます。 < キー > [: < 方向 > ] 方向は、「asc(昇順)」または「desc(降順)」のどちらかです。
limit	query	integer	任意	クエリ結果で返却される項目の最大数指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。
offset	query	integer	任意	limitと組み合わせて、項目の一部分を表示させます。offsetは表示するリストの開始位置です。
marker	query	string	任意	前回のレスポンスの最後の項目のID limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。
with_count	query	boolean	false 任意	レスポンスにある項目の数を表示するかどうかを設定します。 📒注: マイクロバージョン3.45以上を指定してください。

レスポンスボディ（正常系）の説明#

名前	Type	Description
status	string	スナップショットのステータス
description	string	スナップショットの説明
created_at	string	リソースの作成日時日時の入力形式は以下のISO 8601形式です。 `CCYY-MM-DDThh:mm:ss±hh:mm` 例：2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。
name	string	ボリュームトランスファーの名前
user_id	string	ユーザーのUUID 📒注: 表示するにはマイクロバージョン3.41以上を指定してください。
volume_id	string	ボリュームのUUID
metadata	object	スナップショットのメタデータのキーと値のペア
id	string	ボリュームトランスファーのUUID
size	integer	ボリュームのサイズ(GB単位）
count	integer	ページに分割される前の、リクエストされるリソースの総数 📒注: 表示するにはマイクロバージョン3.45以上を指定してください。

レスポンス例#

{
    "snapshots": [
        {
            "status": "available",
            "metadata": {
                "name": "test"
            },
            "name": "test-volume-snapshot",
            "user_id": "40c2102f4a554b848d96b14f3eec39ed",
            "volume_id": "173f7b48-c4c1-4e70-9acc-086b39073506",
            "created_at": "2015-11-29T02:25:51.000000",
            "size": 1,
            "updated_at": "2015-11-20T05:36:40.000000",
            "os-extended-snapshot-attributes:progress": "100%",
            "os-extended-snapshot-attributes:project_id": "0892d23df5c5471da88299517a412b90",
            "id": "b1323cda-8e4b-41c1-afc5-2fc791809c8c",
            "description": "volume snapshot"
        }
    ],
    "count": 10
}