文档首页/ 分布式消息服务Kafka版/ API参考（联盟区域）/ API V2（推荐）/ 用户管理/ 设置用户权限
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置用户权限

功能介绍

设置用户权限。

Kafka实例开启SASL功能时，才支持多用户管理的功能。

URI

POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topics

是

Array of AccessPolicyTopicEntity objects

Topic列表。
表3 AccessPolicyTopicEntity

参数

是否必选

参数类型

描述

name

是

String

Topic名称。

policies

是

Array of AccessPolicyEntity objects

权限列表。
表4 AccessPolicyEntity

参数

是否必选

参数类型

描述

user_name

否

String

用户名称。

设置用户权限时，为必选参数。

access_policy

否

String

权限类型。

  • all：拥有发布、订阅权限;

  • pub：拥有发布权限;

  • sub：拥有订阅权限。

设置用户权限时，为必选参数。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

后台任务ID。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

设置用户权限，为root用户授予发布和订阅topic-test的权限。

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/topics/accesspolicy

{
  "topics" : [ {
    "name" : "topic-test",
    "policies" : [ {
      "user_name" : "root",
      "access_policy" : "all"
    } ]
  } ]
}

响应示例

状态码：200

提交设置用户权限任务成功。

{
  "job_id" : "8a2c259182ab0e9d0182ab1882560010"
}

状态码

状态码

描述

200

提交设置用户权限任务成功。

400

参数无效。

403

鉴权失败。

错误码

请参见错误码。

父主题： 用户管理