调用CheckCloudResourceAuthorized接口查询PolarDB-X实例是否已被授权使用KMS密钥服务。

调试

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

请求参数

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

系统规定参数。取值：CheckCloudResourceAuthorized。

RegionId String 是 cn-hangzhou

实例所属地域的ID。
DBInstanceName String 是 pxc-********

实例ID。
RoleArn String 是 acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

指定已授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息，完成该角色的授权后即可使用相关密钥管理服务，格式：acs:ram::$accountID:role/$roleName 。

  • $accountID：云账号ID。您可以登录阿里云控制台，将鼠标悬停在右上角头像的位置，单击安全设置进行查看。
  • $roleName：RAM角色名称，取值固定为：AliyunRdsInstanceEncryptionDefaultRole。

返回数据

名称 类型 示例值 描述
RequestId String A501A191-BD70-5E50-98A9-C2A486A82****

请求ID。
Data Object

返回体。
AuthorizationState String 0

授权状态，包括如下返回值：

  • 0：未授权；
  • 1：已授权；
  • 2：未开通密钥管理服务。
RoleArn String acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

指定已授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息，完成该角色的授权后即可使用相关密钥管理服务，格式：acs:ram::$accountID:role/$roleName 。

示例

请求示例

http(s)://[Endpoint]/?Action=CheckCloudResourceAuthorized
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&RoleArn=acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole
&公共请求参数

正常返回示例

XML格式 

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

<CheckCloudResourceAuthorizedResponse>
    <RequestId>A501A191-BD70-5E50-98A9-C2A486A82****</RequestId>
    <Data>
        <AuthorizationState>0</AuthorizationState>
        <RoleArn>acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole</RoleArn>
    </Data>
</CheckCloudResourceAuthorizedResponse>

JSON格式 

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

{
  "RequestId" : "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Data" : {
    "AuthorizationState" : "0",
    "RoleArn" : "acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole"
  }
}

错误码

HttpCode 错误码 错误信息 描述
403 IncorrectEngineVersion The current engine version does not support the operation. 当前引擎版本不支持操作。

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