Queries the list of custom keys for a PolarDB cluster.
debugging
debuggingAuthorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | 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-************ |
| RegionId | string | Yes | 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 |
| TDERegion | string | No | The region where the TDE key resides. | cn-beijing |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
"KeyList": [
"0275bd3f-fdbb-4d8c-846b-71b211******"
],
"DBClusterId": "pc-************"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ByokRoleArnNotFound | The roleArn can't be null. | - |
| 401 | ByokNotAuthorizedToRds | This user is not Authorized Rds. | This user is not authorized by ApsaraDB RDS. |
| 403 | UnsupportedKmsService.NotEnabled | KMS service is not enabled. | Key Management Service is not enabled. |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
| 404 | InvalidDBClusterId.NotFound | The 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 time | Summary of changes | Operation | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-12 | The error codes of the API operation change. | see changesets | ||||||||||
|