DescribeEncryptionKey to query custom key details for TDE - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

Before you call this operation, TDE must be enabled for the Tair (Redis OSS-compatible) instance by using a custom key. For more information, see ModifyInstanceTDE.

Note

For more information about TDE, see Enable TDE.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeEncryptionKey

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
DeleteDate	string	The scheduled deletion time of the custom key. 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 request ID.	9A931CE5-C926-5E09-B0EC-6299C4A6****
Description	string	The description of the custom key. An empty string is returned by default.	testkey
Origin	string	The source of the custom key. Aliyun_KMS indicates Alibaba Cloud Key Management Service (KMS).	Aliyun_KMS
MaterialExpireTime	string	The expiration time of the custom key. 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 status 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. `ENCRYPT/DECRYPT` indicates that the key is used for encryption and decryption.	ENCRYPT/DECRYPT
EncryptionKey	string	The custom key ID.	ad463061-992d-4195-8a94-ed63********
Creator	string	The ID of the Alibaba Cloud account 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 RAM role authorized to access the encryption key.	acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

Examples

Success response

JSON format

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

HTTP status code	Error code	Error message	Description
400	InstanceType.NotSupport	Current instance type does not support this operation.	The current instance type does not support this operation

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.