首页 云原生内存数据库Tair API参考 API目录 数据加密 DescribeEncryptionKey - 查询实例的TDE自定义密钥详情

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

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

接口说明

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

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
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********

示例

正常返回示例

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********"
}

错误码

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

阿里云首页 云原生内存数据库Tair 相关技术圈