全部产品
Search
文档中心

云原生数据库 PolarDB:CheckCloudResourceAuthorized - KMS秘钥授权校验

更新时间:Sep 10, 2026

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:CheckCloudResourceAuthorized

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

实例所属地域的 ID。

cn-hangzhou

DBInstanceName

string

实例 ID。

pxc-********

RoleArn

string

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

  • $accountID:云账号 ID。您可以登录阿里云控制台,将鼠标悬停在右上角头像的位置,单击安全设置进行查看。

  • $roleName:RAM 角色名称,取值固定为:AliyunRdsInstanceEncryptionDefaultRole。

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

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

A501A191-BD70-5E50-98A9-C2A486A82****

Data

object

返回体。

AuthorizationState

string

授权状态,包括如下返回值:

  • 0:未授权;

  • 1:已授权;

  • 2:未开通密钥管理服务。

0

RoleArn

string

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

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

403 IncorrectEngineVersion The current engine version does not support the operation. 当前引擎版本不支持操作。

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

变更历史

更多信息,参考变更详情