调用DescribeUserEncryptionKeyList接口查看KMS密钥列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeUserEncryptionKeyList | 系统规定参数。取值：DescribeUserEncryptionKeyList。 |
| DBClusterId | String | 是 | pc-************ | 集群ID。 说明 您可以调用DescribeDBClusters接口查看目标地域下所有的集群信息，包括集群ID。 |
| RegionId | String | 是 | cn-hangzhou | 地域ID。 说明 您可以调用DescribeRegions接口查看目标账号下的可用地域信息，包括地域ID。 |
| TDERegion | String | 否 | cn-beijing | TDE密钥所在地域。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | A7E6A8FD-C50B-46B2-BA85-D8B8D3****** | 请求ID。 |
| KeyList | Array of String | 0275bd3f-fdbb-4d8c-846b-71b211****** | 密钥列表。 |
| DBClusterId | String | pc-************ | 集群ID。 |
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=DescribeUserEncryptionKeyList
&DBClusterId=pc-************
&RegionId=cn-hangzhou
&TDERegion=cn-beijing
&公共请求参数正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeUserEncryptionKeyListResponse>
<RequestId>A7E6A8FD-C50B-46B2-BA85-D8B8D3******</RequestId>
<DBClusterId>pc-************</DBClusterId>
</DescribeUserEncryptionKeyListResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
"KeyList" : [ ],
"DBClusterId" : "pc-************"
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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。 |
访问错误中心查看更多错误码。