Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to query the instance key list.
A maximum of 1000 requests can be initiated per second for this API.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| DBInstanceId | Yes | String | Instance ID. obtain through the api DescribeDBInstances. |
| Parameter Name | Type | Description |
|---|---|---|
| EncryptionKeys | Array of EncryptionKey | Specifies the key information list of the instance. |
| 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. |
This example shows you how to get the key information list of an instance.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEncryptionKeys
<Common request parameters>
{
"DBInstanceId": " postgres-abcdefg"
}
{
"Response": {
"EncryptionKeys": [
{
"CreateTime": "2022-03-24 10:39:14",
"DEKCipherTextBlob": "xxxxxxxxxxx",
"IsEnabled": 1,
"KeyAlias": "PGSQL-KMS",
"KeyId": " f4d88aa7-ae72-11ec-9fcc-5254007ffd46",
"KMSClusterId": "cls-hsm-tyoxxxx",
"KeyRegion": "ap-guangzhou"
}
],
"RequestId": "xxxxxxxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
文档反馈