List backups for project#

バックアップの概要を一覧表示します。

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

HTTPステータスコード#

正常時：200

エラー時：400

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

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

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

名前	Type	Description
backups	array	バックアップオブジェクトの一覧
id	string	バックアップのUUID
links	array	バックアップのリンク
name	string	バックアップの名前
count	integer	ページに分割される前の、リクエストされるリソースの総数 📒注: 表示するにはマイクロバージョン3.45以上を指定してください。

レスポンス例#

{
    "backups": [
         {
        "id": "5e7a312e-af39-4fc0-8633-b8c2cdabb67d",
        "links": [{
            "href": "https://158.69.65.111/volume/v3/ca730406ba3c40b0870e0bd431271736/backups/5e7a312e-af39-4fc0-8633-b8c2cdabb67d",
            "rel": "self"
        }, {
            "href": "https://158.69.65.111/volume/ca730406ba3c40b0870e0bd431271736/backups/5e7a312e-af39-4fc0-8633-b8c2cdabb67d",
            "rel": "bookmark"
        }],
        "name": "tempest-VolumesBackupsAdminTest-Backup-1385312480"
    }
    ],
    "count": 1
}