使用DescribeDBClusterTDE查询集群的TDE设置详情-云原生数据库 PolarDB-阿里云

查询PolarDB引擎集群的TDE设置详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeDBClusterTDE

get

*dbcluster

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

无

请求参数

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

返回参数

名称	类型	描述	示例值
	object
AutomaticRotation	string	是否允许了密钥自动轮转，取值： Enabled：允许 Disabled：不允许说明仅当数据库引擎为 PostgreSQL 兼容或 Oracle 语法兼容时，返回该参数。	Enabled
DBClusterId	string	集群 ID。	pc-***************
EncryptNewTables	string	是否开启自动加密所有新建的表。取值： ON：开启 OFF：关闭说明仅当数据库引擎为 MySQL 兼容时，返回该参数。	ON
EncryptionKey	string	自定义密钥 ID。	2a4f4ac2-**---**********
RequestId	string	请求 ID。	E37D1508-EC3B-4E06-A24A-C7AC31******
RotationInterval	string	在 KMS 设置的密钥自动轮转周期。若未设置密钥自动轮转周期，则返回 0 s。单位：s。例如：轮转周期为 7 天时，返回 604800 s。说明仅当数据库引擎为 PostgreSQL 兼容或 Oracle 语法兼容，且 AutomaticRotation 取值为 Enabled 时，返回该参数。	604800s
TDERegion	string	TDE 密钥所在的地域。	cn-beijing
TDEStatus	string	是否开通 TDE 加密，取值： Enabled：开通 Disabled：关闭	Enabled
EncryptionKeyStatus	string	密钥的状态。返回值： Enabled：启用。 Disabled：未启用。	Enabled

示例

正常返回示例

JSON格式

{
  "AutomaticRotation": "Enabled",
  "DBClusterId": "pc-***************",
  "EncryptNewTables": "ON",
  "EncryptionKey": "2a4f4ac2-****-****-****-************",
  "RequestId": "E37D1508-EC3B-4E06-A24A-C7AC31******",
  "RotationInterval": "604800s",
  "TDERegion": "cn-beijing",
  "TDEStatus": "Enabled",
  "EncryptionKeyStatus": "Enabled"
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的 DBClusterId。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效

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

变更历史

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