DescribeBackupList

Last updated: 2021-08-05 17:35:43

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 parameter. The value used for this API: DescribeBackupList.
Version Yes String Common parameter. The value used for this API: 2019-01-07.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
Limit Yes Integer Backup file list offset
Offset Yes Integer Backup file list start
DbType No String Database type. Valid values:
  • MYSQL
  • 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

    https://cynosdb.tencentcloudapi.com/?Action=DescribeBackupList
    &ClusterId=cynosdbpg-ilgo90hu
    &Offset=0
    &Limit=10
    &<Common request parameters>
    

    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"
          }
        ],
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
      }
    }
    

    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

    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 ({{1}}). Please try again later. If the problem persists, please 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 ({{1}}) does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.