DescribeEncryptionKey -

Queries the details of a custom key for an ApsaraDB for Redis instance to use Transparent Data Encryption (TDE).

Operation description

Before you call this operation, TDE must be enabled for the ApsaraDB for Redis instance by using a custom key. For more information, see ModifyInstanceTDE .

Note For more information about TDE, see Enable TDE.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeEncryptionKey	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. You can call the DescribeInstances operation to query the ID of the instance.	r-bp1zxszhcgatnx****
EncryptionKey	string	No	The ID of the custom key. You can call the DescribeEncryptionKeyList operation to query the ID of the key.	ad463061-992d-4195-8a94-ed63********

Response parameters

Parameter	Type	Description	Example
	object
DeleteDate	string	The time when the custom key is expected to be deleted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note If the return value is an empty string, the custom key cannot be automatically deleted.	2021-09-24T18:22:03Z
RequestId	string	The ID of the request.	9A931CE5-C926-5E09-B0EC-6299C4A6****
Description	string	The description of the custom key. By default, an empty string is returned.	testkey
Origin	string	The source of the custom key. A value of Aliyun_KMS indicates Key Management Service (KMS) of Alibaba Cloud.	Aliyun_KMS
MaterialExpireTime	string	The time when the custom key expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note If the return value is an empty string, the custom key does not expire.	2021-09-24T18:22:03Z
EncryptionKeyStatus	string	The state of the custom key. Valid values: Enabled: The custom key is available. Disabled: The custom key is unavailable.	Enabled
KeyUsage	string	The purpose of the custom key. A value of `ENCRYPT/DECRYPT` indicates encryption and decryption.	ENCRYPT/DECRYPT
EncryptionKey	string	The ID of the custom key.	ad463061-992d-4195-8a94-ed63********
Creator	string	The ID of the Alibaba Cloud account that is used to create the custom key.	17649847********
EncryptionName	string	The encryption algorithm.	AES-CTR-256
RoleArn	string	The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role to which you want to grant permissions.	acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-02-26	API Description Update. The Error code has changed	View Change Details