Create a backup#

バックアップを作成します。

APIエンドポイント#

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

HTTPメソッドとURI#

POST

/v3/{project_id}/backups

HTTPステータスコード#

正常時:202

エラー時:400, 500

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

名前 In Type デフォルト値
/必須指定
Description
project_id path string 必須 プロジェクトのUUID
backup body object 必須 バックアップオブジェクト
volume_id body string 必須 ボリュームのUUID
description body string 任意 バックアップの説明
incremental body boolean false
任意
増分バックアップを行うかどうかを指定します。
force body boolean false
任意
ボリュームがアタッチしている場合でも強制的にバックアップを行うかどうかを指定します。
name body string 任意 バックアップの名前
snapshot_id body string 任意 スナップショットのUUID
metadata body object 任意 バックアップのメタデータのキーと値のペア
📒注: 表示するにはマイクロバージョン3.43以上を指定してください。

レスポンスボディ(正常系)の説明#

名前 Type Description
backup object バックアップオブジェクト
id string バックアップのUUID
links array バックアップのリンク
name string バックアップの名前
metadata object バックアップのメタデータのキーと値のペア
📒注: 表示するにはマイクロバージョン3.43以上を指定してください。

リクエスト例#

{
    "backup": {
        "container": null,
        "description": null,
        "name": "backup001",
        "volume_id": "64f5d2fb-d836-4063-b7e2-544d5c1ff607",
        "incremental": true,
        "metadata": null
    }
}

レスポンス例#

{
    "backup": {
        "id": "deac8b8c-35c9-4c71-acaa-889c2d5d5c8e",
        "links": [
            {
                "href": "http://localhost:8776/v3/c95fc3e4afe248a49a28828f286a7b38/backups/deac8b8c-35c9-4c71-acaa-889c2d5d5c8e",
                "rel": "self"
            },
            {
                "href": "http://localhost:8776/c95fc3e4afe248a49a28828f286a7b38/backups/deac8b8c-35c9-4c71-acaa-889c2d5d5c8e",
                "rel": "bookmark"
            }
        ],
        "name": "backup001",
        "metadata": {}
    }
}