Create backup volume and rule#
共有ストレージのバックアップストレージの作成およびバックアップルールの設定を行います。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
東日本リージョン3の場合 | https://baremetal.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
POST
/v1/disk/backuprule/create
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文字です。 |
RetentionCount | ||||
key | body | string | 必須 | 「RetentionCount」と指定します。 |
value | body | number | 必須 | バックアップを保持する世代数を1~250の整数で指定します。 |
Months | ||||
key | body | string | 任意 | 「Months」と指定します。 |
value | body | string | 任意 | バックアップスケジュール(月)を1~12の整数で指定します。 複数指定する場合はコンマで区切ります。 |
Days | ||||
key | body | string | 任意 | 「Days」と指定します。 |
value | body | string | 任意 | バックアップスケジュール(日)を1~31の整数で指定します。 複数指定する場合はコンマで区切ります。 |
DaysOfWeek | ||||
key | body | string | 任意 | 「DaysOfWeek」と指定します。 |
value | body | string | 任意 | バックアップスケジュール(曜日)を1~7の整数で指定します。 複数指定する場合はコンマで区切ります。 日曜~土曜を1~7で指定します。 |
Hours | ||||
key | body | string | 任意 | 「Hours」と指定します。 |
value | body | string | 任意 | バックアップスケジュール(時)を0~23の整数で指定します。 複数指定する場合はコンマで区切ります。 |
Minutes | ||||
key | body | string | 任意 | 「Minutes」と指定します。 |
value | body | string | 任意 | バックアップスケジュール(分)を0~59の整数で指定します。 複数指定する場合はコンマで区切ります。 |
BackupVolumeSizeTB | ||||
key | body | string | 任意 | 「BackupVolumeSizeTB」と指定します。 |
value | body | string | 任意 | バックアップストレージのサイズを0.5~20.0の範囲で指定します(TB単位) |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
jobId | string | 実行したAPIのジョブID |
リクエスト例#
{ "userInputValues": [ { "key": "TenantId", "value": "76875dbbb8244c809fe12b2f80a0e8c2" }, { "key": "VolumeName", "value": "testvol1" }, { "key": "RetentionCount", "value": "20" }, { "key": "Months", "value": "3" }, { "key": "Days", "value": "3" }, { "key": "DaysOfWeek", "value": "3" }, { "key": "Hours", "value": "1" }, { "key": "Minutes", "value": "0,15,30,45" }, { "key": "BackupVolumeSizeTB", "value": "3" } ] }
レスポンス例#
{ "jobId": "41523" }