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

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeUserEncryptionKeyList

The operation that you want to perform. Set the value to DescribeUserEncryptionKeyList.

DBInstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the region ID of the instance.

TargetRegionId String No cn-hangzhou-h

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

Response parameters

Parameter Type Example Description
KeyIds List 2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

The list of custom keys.

RequestId String 7CD51DA4-A499-43CE-B9B5-20CD4FDC648E

The ID of the request.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=DescribeUserEncryptionKeyList
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>

Sample success responses

XML format 

<RequestId>7CD51DA4-A499-43CE-B9B5-20CD4FDC648E</RequestId>
<KeyIds>
    <KeyId>2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
    <KeyId>578b59ad-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
    <KeyId>749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
</KeyIds>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.