All Products
Document Center

ApsaraDB for MongoDB:DescribeUserEncryptionKeyList

Last Updated:Jan 17, 2023

Queries the list of custom keys for an ApsaraDB for MongoDB instance.

Operation Description

You can use the custom key obtained by calling the DescribeUserEncryptionKeyList operation to enable TDE. For more information, see ModifyDBInstanceTDE.

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:DescribeUserEncryptionKeyList READ
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.

TargetRegionId string No

The zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list.


Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.

KeyIds array

The list of custom keys.


The ID of the key.



Normal return example


  "RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
  "KeyIds": {
    "KeyId": [

Error codes

Http code Error code Error message
403 INVALID_INSNAME_REGIONID_EMPTY The insName and regionId can't be all empty

For a list of error codes, visit the API error center.