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

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeEncryptionKey

系统规定参数,取值:DescribeEncryptionKey

InstanceId String r-bp1zxszhcgatnx****

实例ID,可调用DescribeInstances获取。

RegionId String cn-hangzhou

实例所属地域的ID,可调用DescribeInstances获取。

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

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

返回数据

名称 类型 示例值 描述
Creator String 17649847********

密钥创建者的云账号ID。

DeleteDate String 2021-09-24T18:22:03Z

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

说明 本参数返回内容为空时,表示密钥不会被自动删除。
Description String testkey

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

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

实例的密钥ID。

EncryptionKeyStatus String Enabled

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

  • Enabled:可用。
  • Disabled:不可用。
KeyUsage String ENCRYPT/DECRYPT

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

MaterialExpireTime String 2021-09-24T18:22:03Z

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

说明 本参数返回内容为空时,表示密钥不会过期。
Origin String Aliyun_KMS

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

RequestId String 9A931CE5-C926-5E09-B0EC-6299C4A6****

请求ID。

示例

请求示例

http(s)://r-kvstore.aliyuncs.com/?Action=DescribeEncryptionKey
&InstanceId=r-bp1zxszhcgatnx****
&<公共请求参数>

正常返回示例

XML格式

<DescribeEncryptionKeyResponse>
      <Origin>Aliyun_KMS</Origin>
      <Description>testkey</Description>
      <EncryptionKeyStatus>Enabled</EncryptionKeyStatus>
      <RequestId>9A931CE5-C926-5E09-B0EC-6299C4A6****</RequestId>
      <MaterialExpireTime>2021-09-24T18:22:03Z</MaterialExpireTime>
      <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
      <EncryptionKey>ad463061-992d-4195-8a94-ed63********</EncryptionKey>
      <Creator>17649847********</Creator>
      <DeleteDate>2021-09-24T18:22:03Z</DeleteDate>
</DescribeEncryptionKeyResponse>

JSON格式

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

错误码

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