tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBackupDecryptionKey

Last updated: 2024-11-20 11:15:53

    1. API Description

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

    This API is used to query the decryption key of a backup file.

    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: DescribeBackupDecryptionKey.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID in the format of cdb-XXXX, which is the same as the instance ID displayed in the TencentDB console.
    BackupId Yes Integer Instance backup ID, which can be obtained by the DescribeBackups API.

    3. Output Parameters

    Parameter Name Type Description
    DecryptionKey String The decryption key of a backup file
    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 Querying the decryption key of a backup file

    This example shows you how to query the decryption key of a backup file.

    Input Example

    POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeBackupDecryptionKey<Common request parameters>{    "InstanceId": "cdb-XXXX",    "BackupId": 12345}

    Output Example

    {
    "Response": {
        "DecryptionKey": "XXXXXXXXXXX",
        "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
    InternalError.DBRecordNotExistError The database record does not exist.
    InternalError.UnknownError Unknown error
    OperationDenied.NotSupportBasic Basic instances do not support this operation (feature).
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy