Querying Backups

Function

This API is used to query backups according to search criteria. Before calling this API:

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Querying Full Backups) before then.

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

URI

URI format
GET https://{endpoint}/mysql/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}
Example
GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

Parameter description

**Table 1** Parameter description
Name	Type	Mandatory	Description
project_id	String	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	String	No	DB instance ID.
backup_id	String	No	Backup ID.
backup_type	String	No	Backup type. Values: auto: automated full backup manual: manual full backup
offset	String	No	Index offset. 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	String	No	Number of records to be queried. The default value is 100. The value must be a positive integer. The minimum value is 1 and the maximum value is 100.
begin_time	String	No	Query start time. 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.
end_time	String	No	Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the 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.

Request

None

Response

Normal response

**Table 2** Parameter description
Name	Type	Description
backups	Array of objects	Backup information. For details, see Table 3.
total_count	Integer	Total number of records.

**Table 3** backups field data structure description
Name	Type	Description
id	String	Backup ID.
name	String	Backup name.
begin_time	String	Backup start time 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	Backup end time 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.
status	String	Backup status. Values: BUILDING: Backup in progress COMPLETED: Backup completed FAILED: Backup failed AVAILABLE: Backup available
take_up_time	Integer	Backup duration in minutes.
type	String	Backup type. Values: auto: automated full backup manual: manual full backup
size	Double	Backup size in MB.
datastore	Object	Database information. For details, see Table 4.
instance_id	String	DB instance ID.
backup_level	String	Backup level. This parameter is returned when the level-1 backup function is enabled. Values: 1: level-1 backup 2: level-2 backup 0: Backup being created or creation failed

**Table 4** datastore field data structure description
Name	Type	Description
type	String	DB engine.
version	String	DB version.

Example normal response

{
"backups": [{
"id": "43e4feaab48f11e89039fa163ebaa7e4br01",
"name": "GaussDBforMySQL-gauss-e747-20200705185048266",
"begin_time": "2018-08-06T12:41:14+0800",
"end_time": "2018-08-06T12:45:14+0800",
"take_up_time": 2,
"status": "COMPLETED",
"type": "auto",
"size": 2803,
"datastore": {
"type": "gaussdb-mysql",
"version": "8.0"
},
"instance_id": "c3ec2c6148ad4d71b1a8411a62df0d3cin07",
"backup_level": "2"
}],
"total_count": 1
}