Querying Information About a Cross-Region Backup Policy

Function

This API is used to query information about a cross-region backup policy in the source backup region.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about the request header parameters.

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	Dependencies
rds:instance:getBackupPolicy	read	instance	g:EnterpriseProjectId g:ResourceTag/<tag-key>	rds:instance:list	-

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:getBackupPolicy

read

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:list

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/backups/offsite-policy

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A

Request

Request parameters
None
URI example
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/offsite-policy

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
policy_para	Array of objects	Definition Indicates the backup policy object, including the backup type, backup retention days, target region ID, and target project ID. For details, see Table 3.

**Table 3** policy_para field data structure description
Parameter	Type	Description
backup_type	String	Definition Indicates the backup type. Range auto: automated full backup incremental: automated incremental backup manual: manual backup (returned only for RDS for SQL Server DB instances)
keep_days	Integer	Definition Indicates the number of days to retain the backup files. Range 0–1825 The value 0 indicates that the cross-region backup policy is disabled.
destination_region	String	Definition Indicates the target region ID for the cross-region backup policy. Range The value cannot be empty. To obtain this value, see Regions and Endpoints.
destination_project_id	String	Definition Indicates the target project ID for the cross-region backup policy. Range For details, see Obtaining a Project ID.

Example normal response

When the cross-region backup policy is disabled:

{
	"policy_para": {
		"keep_days": 0
	}
}

When both the automated backup policy and incremental backup policy are enabled for an RDS for MySQL or RDS for PostgreSQL DB instance:

{
	"policy_para": [
            {
		"keep_days": 7,
		"backup_type": "auto",
		"destination_region": "aaa",
                "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
            },
            {
                "keep_days": 7,
		"backup_type": "incremental",
		"destination_region": "aaa",
                "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
             }
	]
}

When the automated backup policy, incremental backup policy, and manual backup policy are enabled for an RDS for SQL Server DB instance:

{
	"policy_para": [
            {
		"keep_days": 7,
		"backup_type": "incremental",
		"destination_region": "aaa",
                "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
            },
            {
                "keep_days": 7,
		"backup_type": "manual",
		"destination_region": "aaa",
                "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
             },
            {
		"keep_days": 7,
		"backup_type": "auto",
		"destination_region": "aaa",
                "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9"
            }
	]
}