GetInstanceAcl - 查询访问权限详情

查询访问权限信息详情。

调试

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

授权信息

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

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

请求语法

GET /instances/{instanceId}/acl/account/{username} HTTP/1.1

请求参数

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

实例 ID。

rmq-cn-7e22ody****
usernamestring

用户名称

abc
resourceTypestring

授权的资源类型

枚举值:
  • Group消费者组
  • Topic主题
Topic
resourceNamestring

授权的资源名称

test

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

AF9A8B10-C426-530F-A0DD-96320B39****
successboolean

执行结果是否成功。

true
dataobject

返回结果

regionIdstring

区域 ID。

cn-hangzhou
instanceIdstring

实例 ID

rmq-cn-7e22ody****
aclTypestring

实例的鉴权类型。

参数取值如下:

  • apache_acl:开源 ACL
  • default:实例默认账号
apache_acl
usernamestring

用户名称

abc
resourceTypestring

授权的资源类型

Topic
resourceNamestring

授权的资源名称

test
decisionstring

授权的决策结果

Allow
actionsarray

授权的操作类型列表。

actionstring

授权的操作类型。

Pub
ipWhitelistsarray

IP 白名单列表

ipWhiteliststring

IP 白名单,支持 IP 和 IP 段。

0.0.0.0/0
codestring

错误码。

MissingInstanceId
messagestring

错误信息。

The instance cannot be found.
httpStatusCodeinteger

HTTP 状态码。

200
dynamicCodestring

动态错误码

InstanceId
dynamicMessagestring

动态错误信息

instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "aclType": "apache_acl",
    "username": "abc",
    "resourceType": "Topic",
    "resourceName": "test",
    "decision": "Allow",
    "actions": [
      "Pub"
    ],
    "ipWhitelists": [
      "0.0.0.0/0"
    ]
  },
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史