文档

ListInstanceAcl - 查询访问权限列表

更新时间:

查询指定实例下的访问权限列表。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

实例 ID

rmq-cn-7e22ody****
pageNumberinteger

当前页码,从 1 开始。

1
pageSizeinteger

分页大小,每页最多显示的返回结果数量。

10
filterstring

查询的过滤条件,若不输入则查询所有权限。

CID-TEST

返回参数

名称类型描述示例值
object

Result

requestIdstring

请求 ID

DA4D2F89-E2C8-5F04-936B-60D55B055FA7
successboolean

是否成功

true
dataobject

返回结果

pageNumberlong

当前页码

1
pageSizelong

分页大小

10
totalCountlong

总记录数

24
listarray<object>

分页数据

aclDatasobject

权限信息

regionIdstring

区域 ID

cn-hangzhou
instanceIdstring

实例 ID

rmq-cn-7e22ody****
aclTypestring

访问类型

枚举值:
  • APACHE开源ACL
APACHE
usernamestring

用户名称

test
resourceTypestring

资源类型

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

资源名称

test
decisionstring

决策结果

枚举值:
  • Deny拒绝访问
  • Allow允许访问
Allow
actionsarray

操作类型

actionstring

操作类型

枚举值:
  • Sub订阅
  • Pub发送
Pub
ipWhitelistsarray

IP 白名单列表

ipWhiteliststring

IP 白名单

0.0.0.0/0
codestring

错误码

MissingInstanceId
messagestring

错误信息

The instance cannot be found.
httpStatusCodeinteger

HTTP 状态码

200
dynamicCodestring

动态错误码

InstanceId
dynamicMessagestring

动态错误信息

InstanceId
accessDeniedDetailstring

访问拒绝详细信息,有且仅有在因 RAM 无权限拒绝用户访问的场景

xxx

示例

正常返回示例

JSON格式

{
  "requestId": "DA4D2F89-E2C8-5F04-936B-60D55B055FA7",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 24,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "aclType": "APACHE",
        "username": "test",
        "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",
  "accessDeniedDetail": "xxx"
}

错误码

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