Queries the Key Management Service (KMS)-managed customer master keys (CMKs) that are used to encrypt data in a PolarDB cluster.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
polardb:DescribeUserEncryptionKeyList | Read |
|
| none |
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
JSON
format
{
"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. |
404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | The specified DBClusterId parameter is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-12 | The Error code has changed | see changesets | ||||||||||
|