DescribeEncryptionDBSecret - 查询加密秘钥状态_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeEncryptionDBSecret

none

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	否	集群 ID。	pc-wz9fb5nn44u1d****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	944CED46-A6F7-40C6-B6DC-C6E5CC******
EncryptionKeyStatus	string	密钥的状态。返回值： Enabled：启用。 Disabled：未启用。	Disabled
EncryptionKey	string	自定义密钥 ID。	2a4f4ac2-**---**********
EncryptionDBStatus	string	是否开通加密，取值： Enabled：开通 Disabled：关闭	cn-beijing
DBClusterId	string	集群 ID。	pc-*************
EncryptionDBRegion	string	加密密钥所在的地域。	Enabled

示例

正常返回示例

JSON格式

{
  "RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "EncryptionKeyStatus": "Disabled",
  "EncryptionKey": "2a4f4ac2-****-****-****-************",
  "EncryptionDBStatus": "cn-beijing",
  "DBClusterId": "pc-*************",
  "EncryptionDBRegion": "Enabled"
}

错误码

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

变更历史

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