文档

DescribeUserEncryptionKeyList - 查询实例的自定义密钥列表

查询实例的自定义密钥列表。

接口说明

使用通过 DescribeUserEncryptionKeyList 查询到的自定义密钥可以开启透明数据加密 TDE。详细信息请参见 ModifyDBInstanceTDE

调试

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

授权信息

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

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

请求参数

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

实例 ID。

dds-bpxxxxxxxx
TargetRegionIdstring

目标可用区 ID,您可以通过 DescribeRegions 查询可用的可用区。

cn-shanghai

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

7CD51DA4-A499-43CE-B9B5-20CD4FDC648E
KeyIdsarray

实例密钥列表。

string

实例密钥。

2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
  "KeyIds": {
    "KeyId": [
      "2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  }
}

错误码

HTTP status code错误码错误信息
403INVALID_INSNAME_REGIONID_EMPTYThe insName and regionId can't be all empty

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈