更新时间:2024-04-02 GMT+08:00

创建策略

功能介绍

创建备份策略。

URI

POST /v3/{project_id}/policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

policy

PolicyCreate object

Request body for creating a policy

表4 PolicyCreate

参数

是否必选

参数类型

描述

enabled

Boolean

Whether to enable the policy

缺省值:true

name

String

Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).

最小长度:1

最大长度:64

operation_definition

PolicyoODCreate object

Scheduling parameter

operation_type

String

Protection type, which can be backup or replication

trigger

PolicyTriggerReq object

Time rule for the policy execution

表5 PolicyoODCreate

参数

是否必选

参数类型

描述

day_backups

Integer

Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

最小值:0

最大值:100

max_backups

Integer

Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

最小值:1

最大值:99999

缺省值:-1

month_backups

Integer

Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

最小值:0

最大值:100

retention_duration_days

Integer

Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

最小值:1

最大值:99999

缺省值:-1

timezone

String

Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

week_backups

Integer

Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

year_backups

Integer

Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

最小值:0

最大值:100

full_backup_interval

Integer

Defines how often (after how many incremental backups) a full backup is performed. If -1 is specified, full backup will not be performed. Minimum value: -1 Maximum value: 100

最小值:-1

最大值:100

表6 PolicyTriggerReq

参数

是否必选

参数类型

描述

properties

PolicyTriggerPropertiesReq object

Scheduler attributes

表7 PolicyTriggerPropertiesReq

参数

是否必选

参数类型

描述

pattern

Array of strings

Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

policy

Policy object

Response to the request for creating a policy

表9 Policy

参数

参数类型

描述

enabled

Boolean

Whether the policy is enabled

id

String

Policy ID

name

String

Policy Name

operation_definition

PolicyoODCreate object

Policy attributes

operation_type

String

Protection type, which can be backup or replication

枚举值:

  • backup

  • replication

trigger

PolicyTriggerResp object

Time scheduling rule for the policy

associated_vaults

Array of PolicyAssociateVault objects

Associated vault

表10 PolicyoODCreate

参数

参数类型

描述

day_backups

Integer

Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

最小值:0

最大值:100

max_backups

Integer

Maximum number of retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

最小值:1

最大值:99999

缺省值:-1

month_backups

Integer

Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

最小值:0

最大值:100

retention_duration_days

Integer

Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

最小值:1

最大值:99999

缺省值:-1

timezone

String

Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups.

week_backups

Integer

Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

year_backups

Integer

Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

最小值:0

最大值:100

full_backup_interval

Integer

Defines how often (after how many incremental backups) a full backup is performed. If -1 is specified, full backup will not be performed. Minimum value: -1 Maximum value: 100

最小值:-1

最大值:100

表11 PolicyTriggerResp

参数

参数类型

描述

id

String

Scheduler ID

name

String

Scheduler name

properties

PolicyTriggerPropertiesResp object

Scheduler attributes

type

String

Scheduler type. Currently, only time (periodic scheduling) is supported.

枚举值:

  • time

表12 PolicyTriggerPropertiesResp

参数

参数类型

描述

pattern

Array of strings

Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

start_time

String

Start time of the scheduler, for example, 2020-01-08 09:59:49

表13 PolicyAssociateVault

参数

参数类型

描述

destination_vault_id

String

ID of the associated remote vault

vault_id

String

Vault ID

请求示例

创建一个备份策略,周一到周天每天14:00执行备份,保留策略按备份保留时长,保留一天。

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies

{
  "policy" : {
    "enabled" : true,
    "name" : "policy001",
    "operation_definition" : {
      "day_backups" : 0,
      "month_backups" : 0,
      "retention_duration_days" : 1,
      "timezone" : "UTC+08:00",
      "week_backups" : 0,
      "year_backups" : 0
    },
    "operation_type" : "backup",
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ]
      }
    }
  }
}

响应示例

状态码: 200

OK

{
  "policy" : {
    "name" : "policy001",
    "enabled" : true,
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
        "start_time" : "2019-05-08T06:57:05.000+00:00"
      },
      "type" : "time",
      "id" : "d67269a6-5369-42d7-8150-5254bd446328",
      "name" : "default"
    },
    "operation_definition" : {
      "retention_duration_days" : 1,
      "year_backups" : 0,
      "day_backups" : 0,
      "month_backups" : 0,
      "week_backups" : 0,
      "timezone" : "UTC+08:00"
    },
    "operation_type" : "backup",
    "id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码