Querying DB Instances for Which Cross-Region Backups Are Created

Function

This API is used to query DB instances for which cross-region backups are created in the target 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:listAll	read	-	-	rds:instance:list	-

URI

URI format
GET /v3/backups/offsite-backup-instance?offset={offset}&limit={limit}

Parameter description

**Table 1** Parameters
Parameter	Type	Mandatory	Description
offset	Integer	No	Definition Index offset. Constraints If offset is set to N, the query starts from the N + 1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number. Range An integer greater than or equal to 0 Default Value 0
limit	Integer	No	Definition Number of records returned by a query. Constraints The value cannot be a negative number. Range 1–100 Default Value 100

Request

Request parameters
None
URI example
- Querying all DB instance lists
  GET https://{endpoint}/v3/backups/offsite-backup-instance
- Querying DB instance lists based on search criteria
  GET https://{endpoint}/v3/backups/offsite-backup-instance?offset=0&limit=10

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
offsite_backup_instances	Array of objects	Definition Indicates information about DB instances for which cross-region backups are created. For details, see Table 3.
total_count	Integer	Definition Indicates the total number of records. Range N/A

**Table 3** offsite_backup_instances field data structure description
Parameter	Type	Description
id	String	Definition Indicates the DB instance ID. Range N/A
name	String	Definition Indicates the name of the DB instance for which cross-region backups are created. Range N/A
source_region	String	Definition Indicates the source backup region. Range N/A
source_project_id	String	Definition Indicates the project ID in the source backup region. Range N/A
datastore	Object	Definition Indicates the database information. For details, see Table 4.
destination_region	String	Definition Indicates the region where the cross-region backup is located. Range N/A
destination_project_id	String	Definition Indicates the project ID in the target backup region. Range N/A
keep_days	Integer	Definition Indicates the number of days to retain cross-region backups. Range N/A

**Table 4** datastore field data structure description
Parameter	Type	Description
type	String	Definition Indicates the DB engine. Range N/A
version	String	Definition Indicates the database version. Range N/A

Example normal response

Querying DB instance lists based on search criteria:

{
        "total_count": 1,
	"offsite_backup_instances": [{
		"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
                "name": "rds-instance-rep2",
                "source_region": "aaa",
                "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
                "datastore": {
			"type": "MySQLPostgreSQL",
			"version": "5.711"
		},
		"destination_region": "bbb",
		"destination_project_id": "0503fd7f7580d3262fc5c001170fbab9",
		"keep_days": 7
		}
    	     ]
}

Querying all DB instance lists:

{
        "total_count": 1,
	"offsite_backup_instances": [{
		"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
                "name": "rds-instance-rep2",
                "source_region": "aaa",
                "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
                "datastore": {
			"type": "MySQLPostgreSQL",
			"version": "5.711"
		},
		"destination_region": "bbb",
		"destination_project_id": "0503fd7f7580d3262fc5c001170fbab9",
		"keep_days": 7
		}
    	     ]
}