tencent cloud



Last updated: 2023-03-29 17:52:48

1. API Description

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

This API is used to query the list of backup files.

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.
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:
  • 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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the backup file list

    Input Example

    POST / HTTP/1.1
    Host: cynosdb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeBackupList
    <Common request parameters>
        "Limit": 10,
        "ClusterId": "cynosdbpg-ilgo90hu",
        "Offset": "0"

    Output Example

        "Response": {
            "TotalCount": 1,
            "BackupList": [
                    "SnapshotId": 10000,
                    "SnapshotTime": "xx",
                    "FileName": "snap",
                    "FileSize": 20190215,
                    "StartTime": "2019-01-20 01:10:12",
                    "FinishTime": "2019-01-20 02:10:12",
                    "BackupType": "snapshot",
                    "BackupMethod": "auto",
                    "BackupStatus": "success",
                    "SnapShotType": "full",
                    "BackupName": "desc123",
                    "BackupId": 100
            "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"

    5. Developer Resources


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

    Command Line Interface

    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.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.
    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support