DescribeDBClusterEncryptionKey - 查询PolarDB实例密钥详情_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询指定PolarDB实例的密钥使用详情。

接口说明

请求说明

该 API 用于获取 PolarDB 实例的密钥使用详情，包括密钥 ID、状态、类型等信息。
DBClusterId参数是必需的，用于指定要查询的 PolarDB 实例 ID。
请确保在调用此接口前已经正确配置了相关的 RAM 角色和策略。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeDBClusterEncryptionKey

get

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	幂等参数	6000170000591aed949d0f******************
DBClusterId	string	否	集群 ID。说明您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。	pc-***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	137ECCC0-920E-5B3B-9F8E-B81632108BBE
EncryptionKeyList	array<object>	密钥列表。
	object	密钥详情。
AliasName	string	密钥别名。	alias/your_default_key
Creator	string	密钥创建者主账号的 UID。	1****1
DeleteDate	string	预计删除密钥时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。若您没有标记密钥删除，该字段为空	2026-05-08T08:14:16Z
Description	string	密钥描述。	Description of the key
EncryptionKey	string	密钥 ID。	51858179-afb3-4369-8329-*********
EncryptionKeyStatus	string	密钥的状态。返回值： Enabled：启用。 Disabled：未启用。	Enabled
KeyType	string	Key 的类型。返回值说明： CMK：用户自定义密钥 ServiceKey：服务密钥	ServiceKey
KeyUsage	string	密钥用途。	ENCRYPT/DECRYPT
MaterialExpireTime	string	密钥过期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2025-10-18T08:14:16Z
Origin	string	密钥的来源。	Aliyun_KMS
UsedBy	string	密钥的使用途径： TDE：透明数据加密。 DiskEncryption：云盘加密。	DiskEncryption

示例

正常返回示例

JSON格式

{
  "RequestId": "137ECCC0-920E-5B3B-9F8E-B81632108BBE",
  "EncryptionKeyList": [
    {
      "AliasName": "alias/your_default_key",
      "Creator": "1****1",
      "DeleteDate": "2026-05-08T08:14:16Z",
      "Description": "Description of the key",
      "EncryptionKey": "51858179-afb3-4369-8329-*********",
      "EncryptionKeyStatus": "Enabled",
      "KeyType": "ServiceKey",
      "KeyUsage": "ENCRYPT/DECRYPT",
      "MaterialExpireTime": "2025-10-18T08:14:16Z",
      "Origin": "Aliyun_KMS",
      "UsedBy": "DiskEncryption"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。
404	InvalidDBInstance.NotFound	The DBClusterId provided does not exist in our records.	我们的记录中不存在提供的DBClusterId。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。