DescribeEncryptionKeyList - Tair - Alibaba Cloud Documentation Center

Queries the custom keys used by an ApsaraDB for Redis instance.

Operation Description

Note

You can specify a custom key when you call the ModifyInstanceTDE operation to enable TDE. You can call the DescribeEncryptionKeyList operation to query the custom keys that are in use. To create a custom key, you can call the CreateKey operation of the Key Management Service (KMS) API.

For more information about TDE and the usage notes of TDE, see Enable TDE.

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	Association operation
kvstore:DescribeEncryptionKeyList	Read	Redis acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraDB for Redis instance. You can call the DescribeInstances operation to query instance IDs.	r-bp1zxszhcgatnx****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	10E2160B-959C-5C3E-BFE6-86EC5925****
KeyIds	array	The custom keys that can be used in the region.
	string	The ID of custom key.	a0e7e2c9-8ee5-40ed-bbca-7dbc********

Examples

Sample success responses

JSONformat

{
  "RequestId": "10E2160B-959C-5C3E-BFE6-86EC5925****",
  "KeyIds": {
    "KeyId": [
      "a0e7e2c9-8ee5-40ed-bbca-7dbc********"
    ]
  }
}

Error codes

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