tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBackups

Last updated: 2024-01-30 10:26:30

    1. API Description

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

    This API (DescribeBackups) is used to query the backups of a TencentDB instance.

    A maximum of 10 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: DescribeBackups.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
    Offset No Integer Offset. Minimum value: 0.
    Limit No Integer Number of entries per page. Value range: 1-100. Default value: 20.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible instances.
    Items Array of BackupInfo Details of eligible backups.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of data backup files

    This example shows you how to query the list of data backup files.

    Input Example

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

{
    "InstanceId": "cdb-c1nl9rpv"
}

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TotalCount": 2,
        "Items": [
            {
                "Status": "SUCCESS",
                "FinishTime": "2017-07-23 12:03:42",
                "Name": "ivansqwutestdr_backup_20170429000134",
                "IntranetUrl": "http://gz.tencent.com",
                "Creator": "SYSTEM",
                "BackupId": 12445233,
                "Date": "2017-04-29 00:01:34",
                "StartTime": "2017-07-22 00:01:34",
                "InternetUrl": "http://gz.tencent.com",
                "Type": "logical",
                "Way": "automatic",
                "ManualBackupName": "ab",
                "SaveMode": "save_mode_regular",
                "RemoteInfo": [],
                "Region": "ap-guangzhou",
                "Method": "full",
                "CosStorageType": 0,
                "Size": 653226
                "InstanceId": "cdb-sadq",
                "EncryptionFlag": "off"
            },
            {
                "Status": "SUCCESS",
                "FinishTime": "2017-07-23 12:03:42",
                "StartTime": "2017-07-23 00:01:34",
                "Name": "ivansqwutestdr_backup_20170430000129",
                "IntranetUrl": "http://gz.tencent.com",
                "Creator": "SYSTEM",
                "BackupId": 436184134,
                "Date": "2017-04-30 00:01:29",
                "InternetUrl": "http://gz.tencent.com",
                "Type": "logical",
                "Way": "automatic",
                "ManualBackupName": "abv",
                "SaveMode": "save_mode_regular",
                "RemoteInfo": [],
                "Region": "ap-guangzhou",
                "Method": "full",
                "CosStorageType": 0,
                "Size": 653226
                "InstanceId": "cdb-asdqwdqd",
                "EncryptionFlag": "on"
            }
        ]
    }
}

    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
    AuthFailure CAM signature/authentication error.
    CdbError Backend or process error.
    InternalError.CdbError System error.
    InternalError.DBError Database exception
    InternalError.DBOperationError Database operation failed.
    InternalError.DatabaseAccessError Internal database error.
    InternalError.DesError Internal system error.
    InternalError.FtpError File transfer exception
    InternalError.HttpError Exceptional HTTP request
    InternalError.UndefinedError Unknown error
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.ControllerNotFoundError This API was not found.
    InvalidParameter.InstanceNotFound The instance does not exist.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    OperationDenied.UserHasNoStrategy This account is not authorized to access the requested resource.
    OperationDenied.WrongStatus The backend task status is invalid.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy