Updated on 2026-03-16 GMT+08:00

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	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Status code: 200

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

**Table 4** BackupPolicy
Parameter	Type	Description
keep_days	Integer	Definition Backup retention days. Range 1–732. You can also contact customer service to extend the retention period to up to 3,660 days.
start_time	String	Definition Backup time window. Automated backups will be triggered during the backup time window. Range The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
period	String	Definition Backup cycle. Data will be automatically backed up on the selected days every week. Range The value is a list of numbers separated by commas (,), where each number plus one represents a day of the week for automated 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	Definition Number of retained level-1 backups. This parameter is returned when level-1 backup is enabled. Range N/A

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