API Explorer

Name	Type	IN	Mandatory	Description
x-auth-token	string	header	Yes	Specifies the user token obtained from the IAM service.
instance_id	string	path	Yes	Specifies the instance ID, which can be obtained by calling the API for querying instances and details. If you do not have an instance, you can call the API used for creating an instance.
project_id	string	path	Yes	Specifies the project ID of a tenant in a region.

Name

Type

Mandatory

Description

x-auth-token

string

header

Yes

Specifies the user token obtained from the IAM service.

instance_id

string

path

Yes

Specifies the instance ID, which can be obtained by calling the API for querying instances and details. If you do not have an instance, you can call the API used for creating an instance.

project_id

string

path

Yes

Specifies the project ID of a tenant in a region.

Name	Type	Mandatory	Description
backup_policy	BackupPolicy object	Yes	Specifies the backup policy object, including the backup retention period (days) and start time.

Name

Type

Mandatory

Description

backup_policy

BackupPolicy object

Yes

Specifies the backup policy object, including the backup retention period (days) and start time.

Parameter:

backup_policy

Name	Type	Mandatory	Description
keep_days	string	Yes	Specifies the number of days to retain the generated backup files.The value range is from 0 to 732. The value 0 indicates that the automated backup policy is disabled.
start_time	string	No	Specifies the backup time window. Automated backups will be triggered during the backup time window. This parameter is mandatory if the automated backup policy is enabled. This parameter is not transferred if the automated backup policy is disabled. The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to 00, 15, 30, or 45. Example value: 08:15-09:15 23:00-00:00
period	string	No	Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. Value range: The value is a number separated by DBS case commas (,). The number indicates the week. The restrictions on the backup retention period are as follows: This parameter is not transferred if its value is set to 0. If you set the retention period to 1 to 6 days, data is automatically backed up each day of the week. Set the parameter value to 1,2,3,4,5,6,7. If you set the retention period to 7 to 732 days, select at least one day of the week for the backup cycle. Example value: 1,2,3,4

Name

Type

Mandatory

Description

keep_days

string

Yes

Specifies the number of days to retain the generated backup files.The value range is from 0 to 732. The value 0 indicates that the automated backup policy is disabled.

start_time

string

Specifies the backup time window. Automated backups will be triggered during the backup time window. This parameter is mandatory if the automated backup policy is enabled. This parameter is not transferred if the automated backup policy is disabled. The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.

The HH value must be 1 greater than the hh value.
The values of mm and MM must be the same and must be set to 00, 15, 30, or 45. Example value:
08:15-09:15
23:00-00:00

period

string

Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. Value range: The value is a number separated by DBS case commas (,). The number indicates the week. The restrictions on the backup retention period are as follows:

This parameter is not transferred if its value is set to 0.
If you set the retention period to 1 to 6 days, data is automatically backed up each day of the week. Set the parameter value to 1,2,3,4,5,6,7.
If you set the retention period to 7 to 732 days, select at least one day of the week for the backup cycle. Example value: 1,2,3,4

Name	Type	Description
error_code	string	Specifies the error returned when a task submission exception occurs.
error_msg	string	Specifies the description of the error returned when a task submission exception occurs.

Name

Type

Description

error_code

string

Specifies the error returned when a task submission exception occurs.

error_msg

string

Specifies the description of the error returned when a task submission exception occurs.

Outline