Create snapshot

スナップショットを任意に採取します。

APIエンドポイント

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

HTTPメソッドとURI

POST

/v1/disk/snapshot/collect

HTTPステータスコード

正常時：201

エラー時：400, 401, 403, 500, 503

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

名前	In	Type	デフォルト値 /必須指定	Description
userInputValues	body	array	必須	次行以降を含むオブジェクトの配列
TenantId
key	body	string	必須	「TenantId」と指定します。
value	body	string	必須	プロジェクトID
VolumeName
key	body	string	必須	「VolumeName」と指定します。
value	body	string	必須	スナップショット作成対象の共有ストレージ名 半角英数字、アンダースコア(_)で構成される文字列を指定します。最大長は140文字です。
SnapshotName
key	body	string	必須	「SnapshotName」と指定します。
value	body	string	必須	作成するスナップショット名 半角英数字、アンダースコア(_)で構成される文字列を指定します。最大長は200文字です。
BackupVolumeName
key	body	string	任意	「BackupVolumeName」と指定します。
value	body	string	任意	スナップショットのバックアップ先ストレージ名 半角英数字、アンダースコア(_)で構成される文字列を指定します。最大長は150文字です。省略した場合は、バックアップされません。
Comment
key	body	string	任意	「Comment」と指定します。
value	body	string	任意	スナップショットのコメント 半角英数字、半角スペース、および以下の記号で構成される文字列を指定します。最大長は255文字です。 !#$%&()*+,-./:;<=>?@[¥]^_{|}~

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

名前	Type	Description
jobId	string	実行したAPIのジョブID

リクエスト例

{
    "userInputValues": [
        {
            "key": "TenantId",
            "value": "76875dbbb8244c809fe12b2f80a0e8c2"
        },
        {
            "key": "VolumeName",
            "value": "testvol1"
        },
        {
            "key": "SnapshotName",
            "value": "testsnap"
        },
        {
            "key": "BackupVolumeName",
            "value": "testvol1_bk001"
        },
        {
            "key": "Comment",
            "value": "test"
        }
    ]
}

レスポンス例

{
    "jobId": "41530"
}