查看KMS密钥列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardb:DescribeUserEncryptionKeyList |
get |
*DBCluster
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBClusterId |
string |
否 |
集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息,包括集群 ID。 |
pc-************ |
| RegionId |
string |
否 |
地域 ID。 说明
您可以调用 DescribeRegions 接口查看目标账号下的可用地域信息,包括地域 ID。 |
cn-hangzhou |
| TDERegion |
string |
否 |
TDE 密钥所在地域。 |
cn-beijing |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
A7E6A8FD-C50B-46B2-BA85-D8B8D3****** |
| KeyList |
array |
集群密钥列表。 |
|
|
string |
密钥列表。 |
0275bd3f-fdbb-4d8c-846b-71b211****** |
|
| DBClusterId |
string |
集群 ID。 |
pc-************ |
示例
正常返回示例
JSON格式
{
"RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
"KeyList": [
"0275bd3f-fdbb-4d8c-846b-71b211******"
],
"DBClusterId": "pc-************"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ByokRoleArnNotFound | The roleArn can't be null. | |
| 401 | ByokNotAuthorizedToRds | This user is not Authorized Rds. | 此用户未经Rds授权。 |
| 403 | UnsupportedKmsService.NotEnabled | KMS service is not enabled. | 未启用KMS服务。 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的 DBClusterId。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。