tencent cloud



Last updated: 2023-06-26 15:13:58

1. API Description

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

This API is used to query the encryption status of the instance data.

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: DescribeDBEncryptAttributes.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of tdsqlshard-ow728lmc

3. Output Parameters

Parameter Name Type Description
EncryptStatus Integer Whether encryption is enabled. Valid values: 1 (enabled), 2 (disabled).
CipherText String DEK
ExpireDate String DEK expiration date
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 None

Input Example

POST / HTTP/1.1Host: dcdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeDBEncryptAttributes<common request parameters{    "InstanceId": "tdsqlshard-lyzax5rb"}

Output Example

    "Response": {
        "CipherText": "",
        "EncryptStatus": 0,
        "ExpireDate": "1970-01-01",
        "RequestId": "7c04c9f9-4b1b-4eed-ac21-45d1d8a261f4"

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.OssOperationFailed Failed to request the backend API.
InternalError Internal error.
InternalError.OperateDatabaseFailed Database operation failed.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound Failed to find the requested instance.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnsupportedOperation.InvalidOperation Unsupported operation.
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