文档

DescribeDBClusterTDE - 查询PolarDB集群的TDE设置详情

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeDBClusterTDERead
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

pc-***************

返回参数

名称类型描述示例值
object
TDEStatusstring

是否开通 TDE 加密,取值:

  • Enabled:开通
  • Disabled:关闭
Enabled
RequestIdstring

请求 ID。

E37D1508-EC3B-4E06-A24A-C7AC31******
DBClusterIdstring

集群 ID。

pc-***************
EncryptionKeystring

自定义密钥 ID。

2a4f4ac2-****-****-****-************
EncryptNewTablesstring

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

  • ON:开启

  • OFF:关闭

ON
TDERegionstring

TDE 密钥所在的地域。

cn-beijing

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
2022-09-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)