DescribeBackupList

Last updated: 2025-11-13 20:51:47

DescribeBackupList

Last updated: 2025-11-13 20:51:47

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to query the backup file list of a cluster.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeBackupList.
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.
ClusterId	Yes	String	Cluster ID
Limit	No	Integer	The number of results to be returned. Value range: (0,100]
Offset	No	Integer	Record offset. Value range: [0,INF)
DbType	No	String	Database type. Valid values: MYSQL
BackupIds.N	No	Array of Integer	Backup ID
BackupType	No	String	Backup type. Valid values: `snapshot` (snapshot backup), `logic` (logic backup).
BackupMethod	No	String	Back mode. Valid values: `auto` (automatic backup), `manual` (manual backup)
SnapShotType	No	String
StartTime	No	String	Backup start time
EndTime	No	String	Backup end time
FileNames.N	No	Array of String
BackupNames.N	No	Array of String	Backup alias, which supports fuzzy query.
SnapshotIdList.N	No	Array of Integer	ID list of the snapshot backup

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of backup files
BackupList	Array of BackupFileInfo	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.

4. Example

Example1 Queries the backup file list

Queries the backup file list

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupList
<Common request parameters>

{
    "Limit": 2,
    "ClusterId": "cynosdbmysql-ck8fmktd",
    "Offset": 0
}

Output Example

{
    "Response": {
        "BackupList": [
            {
                "BackupId": 1880312,
                "BackupMethod": "auto",
                "BackupName": "",
                "BackupStatus": "success",
                "BackupType": "snapshot",
                "FileName": "jia_20241028040005",
                "FileSize": 10426,
                "FinishTime": "2024-10-28 04:02:34",
                "SnapShotType": "increment",
                "SnapshotId": 1880312,
                "SnapshotTime": "2024-10-28 04:00:04",
                "StartTime": "2024-10-28 04:02:14"
            },
            {
                "BackupId": 1879681,
                "BackupMethod": "auto",
                "BackupName": "",
                "BackupStatus": "success",
                "BackupType": "logic",
                "FileName": "jia_20241028022147",
                "FileSize": 1684666,
                "FinishTime": "2024-10-28 02:22:24",
                "SnapShotType": "full",
                "SnapshotId": 1879681,
                "SnapshotTime": "2024-10-28 02:21:47",
                "StartTime": "2024-10-28 02:21:47"
            }
        ],
        "RequestId": "1f2f4b1e-424d-4740-9b26-d947e957780e",
        "TotalCount": 40
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.GetBackupStrategyError	Failed to query the backup policy. Please try again later. If the problem persists, please contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InternalError.SystemError	Internal system error.
InternalError.UnknownError	Unknown internal error.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value.
InvalidParameterValue.ParamError	Incorrect parameter.
InvalidParameterValue.StoragePoolNotFound	No related storage pool found.
ResourceNotFound.ClusterNotFoundError	The cluster does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud