List backups with detail#

バックアップ、および詳細を一覧表示します。

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}/backups/detail

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
backups	array	バックアップオブジェクトの一覧
status	string	バックアップのステータス
object_count	integer	バックアップに含まれるオブジェクトの数
fail_reason	string	バックアップが失敗した場合は、その理由が表示されます。
description	string	バックアップの説明
links	array	バックアップのリンク
availability_zone	string	アベイラビリティゾーンの名前
created_at	string	リソースの作成日時日時の入力形式は以下のISO 8601形式です。 `CCYY-MM-DDThh:mm:ss±hh:mm` 例：2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。
updated_at	string	リソースの最新更新日時日時の入力形式は以下のISO 8601形式です。 `CCYY-MM-DDThh:mm:ss±hh:mm` 例：2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。
name	string	バックアップの名前
has_dependent_backups	boolean	「true」の場合は、このバックアップに依存する他のバックアップが存在します。
volume_id	string	ボリュームのUUID
container	string	バックアップ保存先のコンテナの名前
size	integer	ボリュームのサイズ(GiB単位)
id	string	バックアップのUUID
is_incremental	boolean	バックアップモードが増分かどうかを表示します。「true」の場合は増分バックアップで、「false」の場合はフルバックアップです。
data_timestamp	string	ボリューム上のデータが最初に保存した日時 - ボリュームから取得したバックアップの場合は、バックアップのcreated_atと同じ値です。 - スナップショットから取得したバックアップの場合は、スナップショットのcreated_atと同じ値です。
snapshot_id	string	作成元であるスナップショットのUUID
os-backup-project-attr:project_id	string	プロジェクトのUUID
count	integer	ページに分割される前の、リクエストされるリソースの総数 📒注: 表示するにはマイクロバージョン3.45以上を指定してください。
metadata	object	バックアップのメタデータのキーと値のペア 📒注: 表示するにはマイクロバージョン3.43以上を指定してください。

レスポンス例#

{
    "backups": [
        {
            "availability_zone": "az1",
            "container": "volumebackups",
            "created_at": "2013-04-02T10:35:27.000000",
            "description": null,
            "fail_reason": null,
            "id": "2ef47aee-8844-490c-804d-2a8efe561c65",
            "links": [
                {
                    "href": "http://localhost:8776/v3/c95fc3e4afe248a49a28828f286a7b38/backups/2ef47aee-8844-490c-804d-2a8efe561c65",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:8776/c95fc3e4afe248a49a28828f286a7b38/backups/2ef47aee-8844-490c-804d-2a8efe561c65",
                    "rel": "bookmark"
                }
            ],
            "name": "backup001",
            "object_count": 22,
            "os-backup-project-attr:project_id": "2c67a14be9314c5dae2ee6c4ec90cf0b",
            "size": 1,
            "status": "available",
            "updated_at": "2013-04-02T10:35:27.000000",
            "volume_id": "e5185058-943a-4cb4-96d9-72c184c337d6",
            "is_incremental": true,
            "has_dependent_backups": false
            "metadata": {
                "key": "value"}
        },
        {
            "availability_zone": "az1",
            "container": "volumebackups",
            "created_at": "2013-04-02T10:21:48.000000",
            "description": null,
            "fail_reason": null,
            "id": "4dbf0ec2-0b57-4669-9823-9f7c76f2b4f8",
            "links": [
                {
                    "href": "http://localhost:8776/v3/c95fc3e4afe248a49a28828f286a7b38/backups/4dbf0ec2-0b57-4669-9823-9f7c76f2b4f8",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:8776/c95fc3e4afe248a49a28828f286a7b38/backups/4dbf0ec2-0b57-4669-9823-9f7c76f2b4f8",
                    "rel": "bookmark"
                }
            ],
            "name": "backup002",
            "object_count": 22,
            "os-backup-project-attr:project_id": "2c67a14be9314c5dae2ee6c4ec90cf0b",
            "size": 1,
            "status": "available",
            "updated_at": "2013-04-02T10:21:48.000000",
            "volume_id": "e5185058-943a-4cb4-96d9-72c184c337d6",
            "is_incremental": true,
            "has_dependent_backups": false
            "metadata": {
                "key": "value"}
        }
    ],
    "count": 10
}