文档首页/ 分布式消息服务RocketMQ版/ API参考/ API V2（推荐）/ 用户管理/ 创建用户
更新时间：2024-07-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建用户

功能介绍

创建用户。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/instances/{instance_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

access_key

否

String

用户名，只能英文字母开头，且由英文字母、数字、中划线、下划线组成，长度为7~64个字符。

secret_key

否

String

密钥。

8-32个字符。

至少包含以下字符中的3种：

  • 大写字母

  • 小写字母

  • 数字

  • 特殊字符`~!@#$%^&*()-_=+\|[{}];:'",<.>/?密钥。

    不能与名称或倒序的名称相同。

white_remote_address

否

String

IP白名单。

admin

否

Boolean

是否为管理员。

default_topic_perm

否

String

默认的主题权限。

default_group_perm

否

String

默认的消费组权限。

topic_perms

否

Array of topic_perms objects

特殊的主题权限。

group_perms

否

Array of group_perms objects

特殊的消费组权限。
表3 topic_perms

参数

是否必选

参数类型

描述

name

否

String

主题名称。

perm

否

String

权限。
表4 group_perms

参数

是否必选

参数类型

描述

name

否

String

消费组名称。

perm

否

String

权限。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

access_key

String

用户名，只能英文字母开头，且由英文字母、数字、中划线、下划线组成，长度为7~64个字符。

secret_key

String

密钥。

8-32个字符。

至少包含以下字符中的3种：

  • 大写字母

  • 小写字母

  • 数字

  • 特殊字符`~!@#$%^&*()-_=+\|[{}];:'",<.>/?密钥。

    不能与名称或倒序的名称相同。

white_remote_address

String

IP白名单。

admin

Boolean

是否为管理员。

default_topic_perm

String

默认的主题权限。

default_group_perm

String

默认的消费组权限。

topic_perms

Array of topic_perms objects

特殊的主题权限。

group_perms

Array of group_perms objects

特殊的消费组权限。
表6 topic_perms

参数

参数类型

描述

name

String

主题名称。

perm

String

权限。
表7 group_perms

参数

参数类型

描述

name

String

消费组名称。

perm

String

权限。

请求示例

创建一个非管理员的用户，授予发布、订阅topic1和group1的权限。

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users

{
  "access_key" : "user_name",
  "secret_key" : "**************",
  "white_remote_address" : "",
  "admin" : false,
  "default_topic_perm" : "DENY",
  "default_group_perm" : "DENY",
  "topic_perms" : [ {
    "name" : "topic1",
    "perm" : "PUB|SUB"
  } ],
  "group_perms" : [ {
    "name" : "group1",
    "perm" : "PUB|SUB"
  } ]
}

响应示例

状态码： 200

创建成功。

{
  "access_key" : "test_01",
  "admin" : false,
  "default_group_perm" : "DENY",
  "default_topic_perm" : "SUB",
  "group_perms" : [ ],
  "secret_key" : "**************",
  "topic_perms" : [ ],
  "white_remote_address" : ""
}

状态码

状态码

描述

200

创建成功。

错误码

请参见错误码。

父主题： 用户管理