云数据库 PostgreSQL 查询实例密钥信息列表

1. 接口描述

接口请求域名： postgres.tencentcloudapi.com 。

本接口（DescribeEncryptionKeys）用于查询实例的密钥信息列表。

默认接口请求频率限制：1000次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeEncryptionKeys。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例ID。可通过DescribeDBInstances接口获取示例值：postgres-xxxxxxxx

3. 输出参数

参数名称	类型	描述
EncryptionKeys	Array of EncryptionKey	实例密钥信息列表。示例值：[ { "CreateTime": "2022-03-24 10:39:14", "DEKCipherTextBlob": "xxxxxxxxxxx", "IsEnabled": 1, "KeyAlias": "PGSQL-KMS", "KeyId": " f4d88aa7-ae72-11ec-9fcc-5254007ffd46", "KeyRegion": "ap-guangzhou" } ]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeEncryptionKeys

获取实例的密钥信息列表。

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEncryptionKeys
<公共请求参数>

{
    "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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.FailedOperationError	操作失败，请稍后重试。
InternalError.InternalHttpServerError	请求执行异常。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
OperationDenied.CamDeniedError	当前操作被限制。

查询实例密钥信息列表

本页目录：