文档

DescribeEncryptionKey - 查询实例的TDE自定义密钥详情

更新时间:

查询Redis实例的透明数据加密TDE自定义密钥的详情。

接口说明

调用本接口时,要求实例已通过自定义密钥的方式开启了数据加密 TDE(Transparent Data Encryption)功能,相关接口,请参见 ModifyInstanceTDE

说明 关于透明数据加密 TDE 的详细介绍及注意事项,请参见开启透明数据加密 TDE

调试

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

授权信息

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

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

请求参数

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

实例 ID,可调用 DescribeInstances 获取。

r-bp1zxszhcgatnx****
EncryptionKeystring

实例的自定义密钥 ID,可调用 DescribeEncryptionKeyList 接口查询。

ad463061-992d-4195-8a94-ed63********

返回参数

名称类型描述示例值
object
DeleteDatestring

实例密钥的预计删除时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 本参数返回内容为空时,表示密钥不会被自动删除。
2021-09-24T18:22:03Z
RequestIdstring

请求 ID。

9A931CE5-C926-5E09-B0EC-6299C4A6****
Descriptionstring

密钥的描述信息,默认为空。

testkey
Originstring

密钥材料的来源,返回值Aliyun_KMS,即表示阿里云密钥管理服务 KMS

Aliyun_KMS
MaterialExpireTimestring

密钥的过期时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

说明 本参数返回内容为空时,表示密钥不会过期。
2021-09-24T18:22:03Z
EncryptionKeyStatusstring

实例的密钥状态,返回值:

  • Enabled:可用。
  • Disabled:不可用。
Enabled
KeyUsagestring

实例密钥的用途,返回值ENCRYPT/DECRYPT即表示加密和解密。

ENCRYPT/DECRYPT
EncryptionKeystring

实例的密钥 ID。

ad463061-992d-4195-8a94-ed63********
Creatorstring

密钥创建者的云账号 ID。

17649847********
EncryptionNamestring

加密算法。

AES-CTR-256
RoleArnstring

指定待授权角色的全局资源描述符 ARN(Alibaba Cloud Resource Name)信息。

acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

示例

正常返回示例

JSON格式

{
  "DeleteDate": "2021-09-24T18:22:03Z",
  "RequestId": "9A931CE5-C926-5E09-B0EC-6299C4A6****",
  "Description": "testkey",
  "Origin": "Aliyun_KMS",
  "MaterialExpireTime": "2021-09-24T18:22:03Z",
  "EncryptionKeyStatus": "Enabled",
  "KeyUsage": "ENCRYPT/DECRYPT",
  "EncryptionKey": "ad463061-992d-4195-8a94-ed63********",
  "Creator": "17649847********",
  "EncryptionName": "AES-CTR-256",
  "RoleArn": "acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole"
}

错误码

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

  • 本页导读 (1)
文档反馈