Domain name for API request: cynosdb.intl.tencentcloudapi.com.
Query backup file list based on safe ID
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeBackupListByVault. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| VaultId | Yes | String | Safe ID, length must be greater than 0 |
| BackupIds.N | No | Array of Integer | Backup file ID list for filtering specific backups |
| ClusterId | No | String | Cluster ID for filtering backups of a specific cluster |
| BackupNames.N | No | Array of String | Backup name list for exact matching filter criteria |
| FileNames.N | No | Array of String | Filename list for exact matching filter |
| Limit | No | Integer | Number of pages, range (0,100], default 100 |
| Offset | No | Integer | Pagination offset. Range: [0, INF). Default is 0. |
| OrderBy | No | String | Sorting field. Available values: VaultId, VaultName, BackupSaveSeconds, LockedTime, CreateTime, UpdateTime. Default: createTime. |
| OrderByType | No | String | Sorting method, available values: desc, asc, DESC, ASC, default desc |
| Status | No | String | Status. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total files of backup that meets the conditions |
| BackupList | Array of DescribeBackupListByVaultItem | Backup file list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupListByVault
<Common request parameters>
{
"VaultId": "vault-a6ed23f2-f03e-4410-b946-624d1e7d9b5a"
}
{
"Response": {
"BackupList": [
{
"BackupFileInfo": {
"BackupId": 631,
"BackupMethod": "manual",
"BackupName": "",
"BackupStatus": "success",
"BackupType": "snapshot",
"CopyStatus": "done",
"FileName": "backupT_202602021412_20260202150536",
"FileSize": 4183356,
"FinishTime": "2026-02-02 15:05:41",
"SnapShotType": "full",
"SnapshotId": 631,
"SnapshotTime": "2026-02-02 14:47:38",
"StartTime": "2026-02-02 15:05:36"
},
"ClusterId": "cynosdbmysql-h30xf5d7",
"ClusterName": "backupT_202602021412"
}
],
"TotalCount": 1,
"RequestId": "805500d0-0399-4f8c-acaf-3d6de1d607d5"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback