tencent cloud

Feedback

DescribeEncryptionKeys

Last updated: 2022-10-21 10:49:00

1. API Description

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

This API is used to get instance key list.

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: DescribeEncryptionKeys.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DBInstanceId Yes String Instance ID

3. Output Parameters

Parameter Name Type Description
EncryptionKeys Array of EncryptionKey Instance key list
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 DescribeEncryptionKeys

This example shows you how to get the list of instance keys.

Input Example

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

{
    "DBInstanceId": " postgres-abcdefg"
}

Output Example

{
    "Response": {
        "EncryptionKeys": [
            {
                "CreateTime": "2022-03-24 10:39:14",
                "DEKCipherTextBlob": "xxxxxxxxxxx",
                "IsEnabled": 1,
                "KeyAlias": "PGSQL-KMS",
                "KeyId": " f4d88aa7-ae72-11ec-9fcc-5254007ffd46",
                "KeyRegion": "ap-guangzhou"
            }
        ],
        "RequestId": "xxxxxxxx"
    }
}

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.FailedOperationError Operation failed. Please try again later.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
OperationDenied.CamDeniedError This operation cannot be performed.
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