文档

CheckCloudResourceAuthorized - 查询KMS密钥是否已授权给实例

查询KMS密钥是否已授权给MongoDB实例。

接口说明

在调用 ModifyDBInstanceTDE 接口开启透明数据加密 TDE 前,请调用本接口查询 KMS 密钥是否已授权给 MongoDB 实例。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:CheckCloudResourceAuthorizedRead
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

dds-bp18f7d6b6a7****
TargetRegionIdstring

实例所属地域,您可以调用 DescribeDBInstanceAttribute 查询。

cn-hangzhou

返回参数

名称类型描述示例值
object
AuthorizationStateinteger

授权状态,取值说明:

  • 0:未授权。
  • 1:已授权。
  • 2:用户未开启 KMS。
1
RequestIdstring

请求 ID。

A0181AC4-F186-46ED-87CA-100C70B86729
RoleArnstring

已授权阿里云资源的角色信息。

说明 AuthorizationState 返回值为 1 时,才会返回本参数。
acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole

示例

正常返回示例

JSON格式

{
  "AuthorizationState": 1,
  "RequestId": "A0181AC4-F186-46ED-87CA-100C70B86729",
  "RoleArn": "acs:ram::140****:role/aliyunrdsinstanceencryptiondefaultrole"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈