Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Querying the Full Backups of a Specified Instance

Updated on 2026-02-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Full Backups of a Specified Instance

Function

This API is used to query the full backups of a specified instance. Before calling this API:

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

Calling Method

For details, see Calling APIs.

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	Dependency
gaussdbformysql:instance:listBackup	Read	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:backup:list	-

URI

GET /v3/{project_id}/instances/{instance_id}/backups

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. To obtain this value, see Querying DB Instances. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	String	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0
limit	No	String	Definition Number of records to be queried. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 100
order_field	No	String	Definition Field based on which the query results are sorted. Constraints N/A Range name: backup name beginTime: backup start time type: backup type Default Value N/A
order_rule	No	String	Definition Sorting rule. Constraints N/A Range asc: The query results are displayed in ascending order. desc: The query results are displayed in the descending order. Default Value N/A
filter_field	No	String	Definition Filter field type. Constraints N/A Range name: Filter backups by backup name. Default Value N/A
filter_content	No	String	Definition Filter content. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
backups	Array of BackupV3 objects	Definition Full backups of a specified instance.
total_count	String	Definition Total number of backups. Range N/A

**Table 5** BackupV3
Parameter	Type	Description
id	String	Definition Backup ID. Range N/A
description	String	Definition Backup description. Range N/A
instance_id	String	Definition Instance ID. Range N/A
instance_name	String	Definition Instance name. Range N/A
name	String	Definition Backup name. Range N/A
size	String	Definition Backup size. Range N/A
size_unit	String	Definition Unit of the size (KB). Range N/A
status	String	Definition Backup status. Range BUILDING: backup in progress COMPLETED: backup completed FAILED: backup failed DELETING: backup being deleted
created	String	Definition Creation time. Range N/A
updated	String	Definition Update time. Range N/A
backup_type	String	Definition Backup type. Range Db: physical backup Snapshot: snapshot backup
backup_level	String	Definition Backup level. Range 1: level-1 backup 2: level-2 backup
backup_method	String	Definition Backup method. Range Db: physical backup Snapshot: snapshot backup
use_detail	String	Definition Usage details. Range N/A
time_zone	String	Definition UTC time zone. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying the backups of an instance

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups?offset=0&limit=100

Example Response

Status code: 200

Success.

{
  "backups" : [ {
    "id" : "backup-001",
    "description" : "Daily automated backup",
    "instance_id" : "instance-123",
    "instance_name" : "prod-db",
    "name" : "daily-backup-20231101",
    "size" : "74464.0",
    "size_unit" : "KB",
    "status" : "COMPLETED",
    "created" : "2026-01-04 17:30:30",
    "updated" : "2026-01-04 17:34:24",
    "backup_type" : "Db",
    "backup_level" : "2",
    "backup_method" : "Db",
    "use_detail" : "Production environment backup",
    "time_zone" : "UTC+08:00"
  } ],
  "total_count" : "1"
}