枚举 ACL 策略

最近更新时间:2019-04-26 13:33:17

说明:

该功能目前处于灰度测试阶段,如需要在控制台试用,请通过 提交工单 的方式开通白名单。

1. 接口描述

本接口(ListAcl)用于为实例的用户删除 ACL 策略。

接口请求域名:ckafka.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 必选 类型 描述
instanceId String 实例 ID
resourceType Int ACL 资源类型,(0:UNKNOWN,1:ANY,2:TOPIC,3:GROUP,4:CLUSTER,5:TRANSACTIONAL_ID)
resourceName String 资源名称,和 resourceType 相关,如当 resourceType 为 TOPIC 时,则该字段表示 topic 名称,当 resourceType 为 GROUP 时,该字段表示 group 名称
searchWord String (过滤条件)按照资源名称过滤,支持模糊查询
offset String 偏移量,不填默认为0
limit String 返回数量,不填则默认10,最大值20

3. 出参

参数名称 类型 描述
acls Array ACL 策略的列表
acls::resourceType Int ACL 资源类型,(0:UNKNOWN,1:ANY,2:TOPIC,3:GROUP,4:CLUSTER,5:TRANSACTIONAL_ID)
acls::resourceName String 资源名称,和 resourceType 相关,如当 resourceType 为 TOPIC 时,则该字段表示 topic 名称,当 resourceType 为 GROUP 时,该字段表示 group 名称
acls::operation Int ACL 操作方式,(0:UNKNOWN,1:ANY,2:ALL,3:READ,4:WRITE,5:CREATE,6:DELETE,7:ALTER,8:DESCRIBE,9:CLUSTER_ACTION,10:DESCRIBE_CONFIGS,11:ALTER_CONFIGS,12:IDEMPOTEN_WRITE)
acls::permissionType Int 权限类型(0:UNKNOWN,1:ANY,2:DENY,3:ALLOW)
acls::host String ACL 策略作用的主机 IP
acls::principal Int ACL 关联的用户列表

4.示例

输入:

 https://domain/v2/index.php?Action=ListAcl
  &instanceId=ckafka-tadfqa0
  &resourceType=2
  &resourceName=test-topic
  &<公共请求参数>

输出:

{
"code":0,
"message":"",
"codeDesc":"Success",
"data":{
 "acls":[
  {
   "resourceType":2,
   "resourceName":"topic-a",
   "host":"*",
   "permissionType":3,
   "operation":3,
   "principal":"User:anonymous"
  },
  {
   "resourceType":2,
   "resourceName":"topic-a",
   "host":"*",
   "permissionType":3,
   "operation":3,
   "principal":"User:blob"
  }
 ]
}
}