调用CheckCloudResourceAuthorized查询Redis实例是否已被授权使用KMS密钥服务。

  • 关于透明数据加密TDE(Transparent Data Encryption)的详细介绍及注意事项,请参见开启透明数据加密TDE
  • 调用本接口确认已授权后,您可以调用ModifyInstanceTDE接口开启TDE加密功能。

调试

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

请求参数

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

系统规定参数,取值:CheckCloudResourceAuthorized

InstanceId String r-bp1zxszhcgatnx****

实例ID,可调用DescribeInstances获取。

RoleArn String acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

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

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

实例所属地域的ID,可调用DescribeInstances获取。

返回数据

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

授权状态,返回值:

  • 0:未授权。
  • 1:已授权。
  • 2:未开通密钥管理服务,具体操作,请参见开通密钥管理服务
RequestId String A501A191-BD70-5E50-98A9-C2A486A82****

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CheckCloudResourceAuthorized
&InstanceId=r-bp1zxszhcgatnx****
&RoleArn=acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole
&<公共请求参数>

正常返回示例

XML格式

<CheckCloudResourceAuthorizedResponse>
      <AuthorizationState>1</AuthorizationState>
      <RequestId>A501A191-BD70-5E50-98A9-C2A486A82****</RequestId>
</CheckCloudResourceAuthorizedResponse>

JSON格式

{
    "AuthorizationState": 1,
    "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****"
}

错误码

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