调用DescribeDBClusterTDE接口查询PolarDB MySQL引擎集群的TDE设置详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBClusterTDE

系统规定参数。取值:DescribeDBClusterTDE

DBClusterId String pc-***************

集群ID。

返回数据

名称 类型 示例值 描述
TDEStatus String Enabled

是否开通TDE加密,取值:

  • Enabled:开通
  • Disabled:关闭
RequestId String E37D1508-EC3B-4E06-A24A-C7AC31******

请求ID。

DBClusterId String pc-***************

集群ID。

EncryptionKey String 2a4f4ac2-****-****-****-************

自定义密钥ID。

EncryptNewTables String ON

是否开启自动加密所有新建的表。取值:

  • ON:开启
  • OFF:关闭
TDERegion String cn-beijing

TDE密钥所在的地域。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterTDE
&DBClusterId=pc-***************
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterTDEResponse>
    <TDEStatus>Enabled</TDEStatus>
    <RequestId>E37D1508-EC3B-4E06-A24A-C7AC31******</RequestId>
    <DBClusterId>pc-***************</DBClusterId>
    <EncryptionKey>2a4f4ac2-****-****-****-************</EncryptionKey>
    <EncryptNewTables>ON</EncryptNewTables>
    <TDERegion>cn-beijing</TDERegion>
</DescribeDBClusterTDEResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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。

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