Queries the list of custom keys for a PolarDB cluster.

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.

DBClusterId String Yes pc-************

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the information of all PolarDB clusters that are deployed within a specified region, such as the cluster IDs.
RegionId String Yes cn-hangzhou

The region ID of the cluster.

Note You can call the DescribeRegions operation to query the information of all regions that are available within your account, such as the region IDs.
TDERegion String No cn-beijing

The region where the TDE key resides.

Response parameters

Parameter Type Example Description
RequestId String A7E6A8FD-C50B-46B2-BA85-D8B8D3******

The ID of the request.

KeyList Array of String 0275bd3f-fdbb-4d8c-846b-71b211******

The list of keys.

DBClusterId String pc-************

The ID of the cluster.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeUserEncryptionKeyList
&DBClusterId=pc-************
&RegionId=cn-hangzhou
&TDERegion=cn-beijing
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeUserEncryptionKeyListResponse>
    <RequestId>A7E6A8FD-C50B-46B2-BA85-D8B8D3******</RequestId>
    <DBClusterId>pc-************</DBClusterId>
</DescribeUserEncryptionKeyListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "KeyList" : [ ],
  "DBClusterId" : "pc-************"
}

Error codes

HTTP status code Error code Error message Description
401 ByokNotAuthorizedToRds This user is not Authorized Rds. The error message returned because this user is not authorized by ApsaraDB RDS.
403 UnsupportedKmsService.NotEnabled KMS service is not enabled. The error message returned because KMS is not activated.
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId does not exist.
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist in the current record.

For a list of error codes, see Service error codes.