All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeUserEncryptionKeyList

Last Updated:Mar 15, 2024

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 .

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:DescribeUserEncryptionKeyListREAD
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

dds-bpxxxxxxxx
TargetRegionIdstringNo

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

cn-shanghai

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7CD51DA4-A499-43CE-B9B5-20CD4FDC648E
KeyIdsarray

The list of custom keys.

string

The ID of the key.

2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
  "KeyIds": {
    "KeyId": [
      "2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  }
}

Error codes

HTTP status codeError codeError message
403INVALID_INSNAME_REGIONID_EMPTYThe insName and regionId can't be all empty

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

Change history

Change timeSummary of changesOperation
No change history