全部产品
Search
文档中心

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

更新时间:Nov 06, 2024

查询云数据库 Tair(兼容 Redis)实例使用的自定义密钥列表。

接口说明

  • 调用 ModifyInstanceTDE 开启透明数据加密 TDE 时,可使用自定义密钥,本接口可帮助您查询实例已使用的自定义密钥。如需创建自定义密钥,请调用密钥管理服务的 CreateKey 接口。
  • 关于透明数据加密 TDE 的详细介绍及注意事项,请参见开启透明数据加密 TDE

调试

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

授权信息

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

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

请求参数

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

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

10E2160B-959C-5C3E-BFE6-86EC5925****
KeyIdsarray

该地域下可使用的自定义密钥的列表。

KeyIdstring

自定义密钥。

a0e7e2c9-8ee5-40ed-bbca-7dbc********

示例

正常返回示例

JSON格式

{
  "RequestId": "10E2160B-959C-5C3E-BFE6-86EC5925****",
  "KeyIds": {
    "KeyId": [
      "a0e7e2c9-8ee5-40ed-bbca-7dbc********"
    ]
  }
}

错误码

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