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

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

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeUserEncryptionKeyList

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称

类型

必填

描述

示例值

DBInstanceId

string

实例 ID。

dds-bpxxxxxxxx

TargetRegionId

string

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

cn-shanghai

RoleARN

string

指定角色的 ARN。格式:acs:ram::$accountID:role/$roleName ,默认值为:acs:ram::$accountID:role/aliyunrdsinstanceencryptiondefaultrole

说明
  • $accountID:云账号 ID。您可以通过登录阿里云控制台,将鼠标悬停在右上角头像的位置,单击安全设置进行查看。

  • $roleName:RAM 角色名称。您可以通过登录 RAM 控制台,单击左侧导航栏的 RAM 角色管理,在 RAM 角色名称列表下进行查看。

acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

KeyIds

object

KeyId

array

实例密钥列表。

string

实例密钥。

2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

403 INVALID_INSNAME_REGIONID_EMPTY The insName and regionId can't be all empty

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

变更历史

更多信息,参考变更详情