Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Backup Management/ Querying Backup Details (a V3 API)
Updated on 2026-05-30 GMT+08:00
View PDF
Share

Querying Backup Details (a V3 API)

Function

This API is used to query backup details.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

instance_id

Yes

String

Instance ID

backup_id

Yes

String

Backup ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Backup ID

name

String

Backup name

instance_id

String

Instance ID

instance_name

String

Instance name

related_data_nodes

Array of RelatedDn objects

Associated data nodes
Table 4 RelatedDn

Parameter

Type

Description

instance_id

String

Data node ID

instance_name

String

Data node name

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

Querying backup details

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/cfea30126a884f46887b4e9211460fc1br09

Example Response

Status code: 200

{
  "id": "09902ee7866649b8908ec209bfee2747br09",
  "name": "Backup-ddm-diagnose3-2u8g-1-4bfGfxqdESTHbkKm5XrWLg-2025052005400",
  "instance_id": "34970585d4964f2a8d6d9ea8d303398bin09",
  "instance_name": "ddm-diagnose3-2u8g-1-4bfGfxqdESTHbkKm5XrWLg",
  "related_data_nodes": [
    {
      "instance_id": "fc33739e5d2741529e21d87a7b5923fain01",
      "instance_name": "mysql_rds_related_ddm_for_diagnose3_01"
    }
  ]
}

Status code: 400

Bad request

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status code: 500

Server error

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status Codes

Status Codes

Description

200

OK

400

Bad request

500

Server error

Error Codes

For details, see Error Codes.

Parent topic: Backup Management