Querying Details About Cross-Region Backups

Function

This API is used to query details about cross-region backups in the target backup region.

Before calling an API, you need to understand the API in Authentication.

URI

URI format
GET /v3/{project_id}/offsite-backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time}
Example
https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/offsite-backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800

Parameter description

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id	Yes	Specifies the DB instance ID.
backup_id	No	Specifies the backup ID.
backup_type	Yes	Specifies the backup type. Its value can be any of the following: auto: automated full backup and manual backup. incremental: automated incremental backup
offset	No	Specifies the index position. If offset is set to N, the resource 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 cannot be a negative number.
limit	No	Specifies the number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.
begin_time	No	Specifies the start time for obtaining the cross-region backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ". NOTE: When begin_time is not empty, end_time is mandatory.
end_time	No	Specifies the end time for obtaining the cross-region backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time. NOTE: When end_time is not empty, begin_time is mandatory.

Request

None

Response

Normal response

**Table 2** Parameter description
Name	Type	Description
backups	Array of objects	Indicates the backup list. For details, see Table 3.
total_count	Integer	Indicates the total number of records.

**Table 3** backups field data structure description
Name	Type	Description
id	String	Indicates the backup ID.
name	String	Indicates the backup name.
type	String	Indicates the backup type. This parameter is returned only for RDS for MySQL and RDS for PostgreSQL DB instances. Its value can be any of the following: auto: automated full backup incremental: automated incremental backup
size	Long	Indicates the backup size in KB.
status	String	Indicates the backup status. Its value can be any of the following: BUILDING: Backup in progress COMPLETED: Backup completed FAILED: Backup failed DELETING: Backup being deleted
begin_time	String	Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.
end_time	String	Indicates the backup end time. For a full backup, it indicates the full backup end time. For an incremental backup, it indicates the time when the last transaction in the backup file was submitted. The format is yyyy-mm-ddThh:mm:ssZ.
datastore	Object	Indicates the database version. For details, see Table 4.
instance_id	String	Indicates the ID of the DB instance for which the backup is created.
associated_with_ddm	Boolean	Indicates whether to associate with DDM. This parameter is returned only for RDS for MySQL DB instances.

**Table 4** datastore field data structure description
Name	Type	Description
type	String	Indicates the DB engine. Currently, only MySQL is supported.
version	String	Indicates the database version.

Example normal response

MySQL:

{
	"backups": [{
		"id": "43e4feaab48f11e89039fa163ebaa7e4br01",
		"name": "xxxx.xxx",
		"type": "auto",
		"size": 2803,
		"status": "COMPLETED",
		"begin_time": "2018-08-06T12:41:14+0800",
		"end_time": "2018-08-06T12:43:14+0800",
		"datastore": {
			"type": "MySQL",
			"version": "5.6"
		},
		"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01",
                "associated_with_ddm": false
	}],
	"total_count": 1
}

PostgreSQL:

{
	"backups": [{
		"id": "43e4feaab48f11e89039fa163ebaa7e4br01",
		"name": "xxxx.xxx",
		"type": "auto",
		"size": 2803,
		"status": "COMPLETED",
		"begin_time": "2018-08-06T12:41:14+0800",
		"end_time": "2018-08-06T12:43:14+0800",
		"datastore": {
			"type": "PostgreSQL",
			"version": "9.6"
		},
		"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01"
	}],
	"total_count": 1
}