All Products
Search
Document Center

PolarDB:DescribeUserEncryptionKeyList

Last Updated:Nov 07, 2023

Queries the list of custom keys for a PolarDB cluster.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.
pc-************
RegionIdstringYes

The ID of the region.

Note You can call the DescribeRegions operation to query all regions that are available for your account, such as the region ID.
cn-hangzhou
TDERegionstringNo

The region where the TDE key resides.

cn-beijing

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

A7E6A8FD-C50B-46B2-BA85-D8B8D3******
DBClusterIdstring

The ID of the cluster.

pc-************

Examples

Sample success responses

JSONformat

{
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "KeyList": [
    "0275bd3f-fdbb-4d8c-846b-71b211******"
  ],
  "DBClusterId": "pc-************"
}

Error codes

HTTP status codeError codeError messageDescription
400ByokRoleArnNotFoundThe roleArn can't be null.-
401ByokNotAuthorizedToRdsThis user is not Authorized Rds.This user is not authorized by ApsaraDB RDS.
403UnsupportedKmsService.NotEnabledKMS service is not enabled.Key Management Service is not enabled.
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

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

Change history

Change timeSummary of changesOperation
2023-09-12The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 401
    delete Error Codes: 403