DescribeDBInstanceEncryptionKey - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the details of a key for an ApsaraDB for MongoDB instance.

Operation description

When you call the DescribeDBInstanceEncryptionKey operation, the instance must have transparent data encryption (TDE) enabled in BYOK mode. You can call the ModifyDBInstanceTDE operation to enable TDE.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
dds:DescribeDBInstanceEncryptionKey	READ	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp2235****
EncryptionKey	string	No	The custom key for the instance. You can call the DescribeUserEncryptionKeyList operation to query the list of custom keys for an ApsaraDB for MongoDB instance.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
Origin	string	The source of the key for the instance.	Aliyun_KMS
Description	string	The description of the key for the instance.	key description example
RequestId	string	The request ID.	783C2062-A2D3-4EA8-88AD-E43F990C23BB
EncryptionKeyStatus	string	Indicates whether the key for the instance is enabled. Valid values: Enabled Disabled	Enabled
MaterialExpireTime	string	The expiration time of the key for the instance. The time is displayed in UTC. If the parameter is left empty, the key for the instance will not expire.	2020-07-06T18:22:03Z
KeyUsage	string	The purpose of the key for the instance.	ENCRYPT/DECRYPT
EncryptionKey	string	The key for the instance.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Creator	string	The UID of the key creator.	123456
DeleteDate	string	The scheduled time when the key for the instance will be deleted. If the parameter is left empty, the key will not be deleted.	2020-07-06T18:22:03Z

Examples

Sample success responses

JSONformat

{
  "Origin": "Aliyun_KMS",
  "Description": "key description example",
  "RequestId": "783C2062-A2D3-4EA8-88AD-E43F990C23BB",
  "EncryptionKeyStatus": "Enabled",
  "MaterialExpireTime": "2020-07-06T18:22:03Z",
  "KeyUsage": "ENCRYPT/DECRYPT",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Creator": "123456",
  "DeleteDate": "2020-07-06T18:22:03Z"
}

Error codes

HTTP status code	Error code	Error message
403	INVALID_INSNAME_REGIONID_EMPTY	The insName and regionId can't be all empty
403	NO_ACTIVE_BYOK	This custins no active byok.

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

Change history

Change time	Summary of changes	Operation

No change history