All Products
Document Center

ApsaraDB for MongoDB:DescribeDBInstanceEncryptionKey

Last Updated:Jan 17, 2023

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.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
dds:DescribeDBInstanceEncryptionKey READ
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.

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.


Response parameters

Parameter Type Description Example
Origin string

The source of the key for the instance.

Description string

The description of the key for the instance.

key description example
RequestId string

The ID of the request.

EncryptionKeyStatus string

Indicates whether the key for the instance is enabled. Valid values:

  • Enabled
  • Disabled
MaterialExpireTime string

The expiration time of the key for the instance. The time is displayed in UTC. If the value is empty, the key for the instance will not expire.

KeyUsage string

The purpose of the key for the instance.

EncryptionKey string

The key for the instance.

Creator string

The UID of the key creator.

DeleteDate string

The scheduled time when the key for the instance will be deleted. If the value is empty, the key will not be deleted.



Normal return example


  "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 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 API error center.