调用CheckKMSAuthorized接口查看用户KMS开通状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CheckKMSAuthorized

系统规定参数。取值：CheckKMSAuthorized。
RegionId String 否 cn-hangzhou

地域ID。

说明 您可以调用DescribeRegions接口查看目标账号下的可用地域信息，包括地域ID。
DBClusterId String 是 pc-************

集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有的集群信息，包括集群ID。
TDERegion String 否 cn-beijing

TDE密钥所在地域。

返回数据

名称 类型 示例值 描述
AuthorizationState Integer 0

授权状态。取值范围如下：

  • 0：未授权。
  • 1：已授权。
RequestId String A7E6A8FD-C50B-46B2-BA85-D8B8D3******

请求ID。
RoleArn String acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole

角色的全局资源描述符，用来指定具体角色。详情请参见RAM角色概览。
DBClusterId String pc-************

集群ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=CheckKMSAuthorized
&RegionId=cn-hangzhou
&DBClusterId=pc-************
&TDERegion=cn-beijing
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CheckKMSAuthorizedResponse>
    <AuthorizationState>0</AuthorizationState>
    <RequestId>A7E6A8FD-C50B-46B2-BA85-D8B8D3******</RequestId>
    <RoleArn>acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole</RoleArn>
    <DBClusterId>pc-************</DBClusterId>
</CheckKMSAuthorizedResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AuthorizationState" : 0,
  "RequestId" : "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "RoleArn" : "acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole",
  "DBClusterId" : "pc-************"
}

错误码

HttpCode 错误码 错误信息 描述
403 UnsupportedKmsService.NotEnabled KMS service is not enabled. 未启用KMS服务。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

访问错误中心查看更多错误码。