Querying an Automated Backup Policy

This API is used to query an automated backup policy. Before calling this API:

GET /v3/{project_id}/instances/{instance_id}/backups/policy

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
backup_policy	BackupPolicy object	Backup policy information.

**Table 4** BackupPolicy
Parameter	Type	Description
keep_days	Integer	Backup retention days. Value range: 1–732. You can also contact customer service to extend the retention period to 3,660 days. Minimum value: 1 Maximum value: 732
start_time	String	Backup time window. Automated backups will be triggered during the backup time window. The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
period	String	Backup cycle configuration. Data will be automatically backed up on the selected days every week. The value is a list of numbers separated by commas (,), where each number plus one represents a day of the week for automatic backups. For example, 1,2,3,4,5,6,7 indicates that data is backed up every day from Tuesday to Monday.
retention_num_backup_level1	Integer	Number of retained level-1 backups. This parameter is returned when level-1 backup is enabled.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Querying the automated backup policy of a DB instance

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups/policy

Status code: 200

Success.

{
  "backup_policy" : {
    "keep_days" : "7,",
    "start_time" : "19:00-20:00",
    "period" : "1,2",
    "retention_num_backup_level1" : 1
  }
}

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Backup Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.