project_id

Yes

String

Project ID

operation_type

No

String

Policy type

Enumeration values:

• backup

• replication

vault_id

No

String

Vault ID

X-Auth-Token

Yes

String

User token.

Obtained by calling the corresponding IAM API. If the request is successfully processed, the value of X-Subject-Token included in the response header is the token value.

policies

Array of Policy objects

count

Integer

enabled

Boolean

Whether the policy is enabled

id

String

Policy ID

name

String

Policy name

operation_definition

PolicyoODCreate object

Policy attributes

operation_type

String

Policy type

Enumeration values:

• backup

• replication

trigger

PolicyTriggerResp object

Time scheduling rule for the policy

associated_vaults

Array of PolicyAssociateVault objects

Associated vault

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.

Minimum: 0

Maximum: 100

destination_project_id

String

ID of the replication destination project, which is mandatory for cross-region replication

destination_region

String

ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).

enable_acceleration

Boolean

Whether to enable the acceleration function to shorten the replication time for cross-region replication. If this parameter is not set, the acceleration function is disabled.

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.

Minimum: 1

Maximum: 99999

Default: -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.

Minimum: 0

Maximum: 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.

Minimum: 1

Maximum: 99999

Default: -1

timezone

String

Time zone where the user is located, for example, UTC+08:00. Set this parameter only after 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.

Minimum: 0

Maximum: 100

id

String

Scheduler ID

name

String

Scheduler name

properties

PolicyTriggerPropertiesResp object

Scheduler attributes

type

String

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

Enumeration values:

• time

pattern

Array of strings

Scheduling policy of the scheduler. The value consists of a maximum of 10,240 characters and complies with iCalendar RFC 2445, but it supports only four parameters, which are FREQ, BYDAY, BYHOUR, and BYMINUTE. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, or 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.

start_time

String

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

destination_vault_id

String

ID of the destination vault

vault_id

String

Vault ID

200

OK