Obtaining Backups

Function

This API is used to obtain backups of a DB instance.

Constraints

This API supports queries of full and incremental backups of a DB instance.

URI

URI format
GET /v3/{project_id}/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}

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A
instance_id	Yes	String	Explanation: Instance ID. Constraints: N/A Value range: N/A Default value: N/A
backup_id	No	String	Explanation: Backup ID. Constraints: N/A Value range: N/A Default value: N/A
backup_type	No	String	Explanation: Backup type. Constraints: N/A Value range: auto: automated full backup manual: manual full backup fragment: differential full backup incremental: automated incremental backup Default value: N/A
status	No	String	Explanation: Backup status. Constraints: N/A Value range: BUILDING: backup in progress COMPLETED: backup completed FAILED: backup failed Default value: N/A
offset	No	Integer	Explanation: Index offset. Constraints: N/A Value range: 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. Default value: 0
limit	No	Integer	Explanation: Number of records to be queried. Constraints: N/A Value range: The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100. Default value: 100
begin_time	No	String	Explanation: Query start time. Constraints: When begin_time is not empty, end_time is mandatory. Value range: The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800. Default value: N/A
end_time	No	String	Explanation: Query end time. Constraints: When end_time is not empty, begin_time is mandatory. Value range: The value is in the "yyyy-mm-ddThh:mm:ssZ" format and must be later than the query start time. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800. Default value: N/A

Request Parameters

None

Example Request

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4in01&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

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
backups	Array of objects	Explanation: Backup list. For details, see Table 3.
total_count	Integer	Explanation: Total number of records. Value range: N/A

**Table 3** backups field data structure description
Parameter	Type	Description
id	String	Explanation: Backup ID. Value range: N/A
name	String	Explanation: Backup name. Value range: N/A
type	String	Explanation: Backup type. Value range: auto: automated full backup manual: manual full backup fragment: differential full backup incremental: automated incremental backup
size	Long	Explanation: Backup size, in KB. Value range: N/A
status	String	Explanation: Backup status. Value range: BUILDING: backup in progress COMPLETED: backup completed FAILED: backup failed DELETING: backup being deleted
begin_time	String	Explanation: Backup start time. For a full backup, it indicates the full backup start time. For an incremental backup, it indicates the time when the last transaction of the last incremental backup task is committed. Value range: The value is in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.
end_time	String	Explanation: 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 is committed. Value range: The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.
datastore	Object	Explanation: Database version. For details, see Table 4.
instance_id	String	Explanation: ID of the instance for which the backup is created. Value range: N/A
associated_with_ddm	Boolean	Explanation: Whether this instance is associated with a DDM instance. Value range: N/A

**Table 4** datastore field data structure description
Parameter	Type	Description
type	String	Explanation: DB engine. Value range: MySQL
version	String	Explanation: DB engine version. Value range: 5.7 or 8.0

Example normal response

{
	"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.7"
		},
		"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01",
		"associated_with_ddm": false
	}],
	"total_count": 1
}