Updated on 2026-08-31 GMT+08:00

Querying Same-Region Backup Policies

Function

This API is used to query automated backup policies of an instance, including standard backup policies and sparse backup policies. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
gaussdbformysql:backup:listPolicy	List	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:backup:list	-

URI

GET /v3/{project_id}/instances/{instance_id}/backups/advanced-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. To obtain this value, see Querying DB Instances. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**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: English zh-cn: Chinese Default Value en-us

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
begin_time	String	Definition Start time of the backup time window. Range The value cannot be left blank. It must be a valid value in the hh:mm format. The current time is the UTC time.
end_time	String	Definition End time of the backup time window. Range The value cannot be left blank. It must be a valid value in the hh:mm format. The current time is the UTC time. The value of end_time must be later than that of begin_time.
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
policies	Array of BackupPolicy objects	Definition Backup policies.

**Table 4** BackupPolicy
Parameter	Type	Description
retention_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.
period	String	Definition Backup cycle. Range The value must be a cron expression in the format of "day month week" in the UTC time zone. The day can be a number ranging from 1 to 31, the special character * (indicating any value), or the special character L (indicating the last day). You can enter multiple values ranging from 1 to 31 or L and separate them with commas (,). The month can be a number ranging from 1 to 12 or the special character * (indicating any value). The week can be a number ranging from 1 to 7. You can enter multiple numbers separated by commas (,).
policy_type	String	Definition Type of the automated backup policy. Range base: standard backup policy sparse: sparse backup policy

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.

Example Request

Querying automated backup policies of an instance

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

Example Response

Status code: 200

Success.

{
  "begin_time" : "19:00",
  "end_time" : "20:00",
  "policies" : [ {
    "period" : "* * 1,2,3,4,5",
    "retention_days" : 7,
    "policy_type" : "base"
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Backup Management