Querying Backups

Function

This API is used to query backups.

Constraints

None

URI

GET /v3/{project_id}/backups

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. The query starts from the next piece of data indexed by this parameter. The value is 0 by default. The value must be a non-negative number.
limit	No	Integer	Maximum records to be queried. Value range: 1 to 128. If the parameter value is not specified, 10 records are obtained by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token You can obtain the token by calling the IAM API used to obtain a user token.

Example Request

This API is used to query backups.

GET https://{endpoint}/v3/project_id/backups?offset=0&limit=10

Response

Normal response

**Table 4** Response body parameters
Parameter	Type	Description
backups	Array of BackupInfo objects	Backup list.
offset	Integer	Which page the server starts returning items
limit	Integer	Number of records displayed on each page
total	Integer	Total number of backup records

**Table 5** BackupInfo
Parameter	Type	Description
id	String	Backup ID
name	String	Parameter template name
description	String	Parameter template description
status	String	Backup status
instance_id	String	Instance ID
instance_name	String	Instance name
instance_status	String	Instance status
file_size	Double	Backup size, in KB
created	String	Creation 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 offset is +0800.
updated	String	Update 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 offset is +0800.
backup_type	String	Backup type: auto_metadata: Metadata backup is triggered by a scheduled task every day. metadata: Metadata backup is not triggered by a scheduled task. For example, metadata is backed up before instance deletion.

Normal response example

{
  "backups": [
    {
      "id": "c131f9339****5cdebe350228br09",
      "name": "Backup",
      "description": "auto metadata backup",
      "status": "normal",
      "instance_id": "169f4f2fd6****04385a18ain09",
      "instance_name": "ddm-test",
      "instance_status": "normal",
      "file_size": 5.419922,
      "created": "2025-02-19T02:50:20+0000",
      "updated": "2025-02-19T02:50:37+0000",
      "backup_type": "auto_metadata"
    }
  ],
  "total": 1,
  "offset": 0,
  "limit": 10
}