文档首页/ 分布式消息服务RocketMQ版/ API参考（联盟区域）/ API V2（推荐）/ 用户管理/ 修改用户参数
更新时间：2026-04-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改用户参数

功能介绍

修改用户参数。

URI

PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

user_name

是

String

参数解释：

用户名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

access_key

是

String

参数解释：

用户名，不支持修改，需要填写当前已设置的用户名称。

约束限制：

与原用户保持一致。

取值范围：

不涉及。

默认取值：

不涉及。

secret_key

是

String

参数解释：

密钥。

约束限制：

8-32个字符。

不能以-开头，至少包含以下字符中的3种：

  • 大写字母

  • 小写字母

  • 数字

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

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

取值范围：

不涉及。

默认取值：

不涉及。

white_remote_address

否

String

参数解释：

IP白名单。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

admin

否

Boolean

参数解释：

是否为管理员。

约束限制：

不涉及。

取值范围：

  • true：是管理员。

  • false：不是管理员。

默认取值：

不涉及。

default_topic_perm

否

String

参数解释：

默认的主题权限。

约束限制：

不涉及。

取值范围：

  • PUB：拥有发布权限。

  • SUB：拥有订阅权限。

  • PUB|SUB：拥有发布订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

default_group_perm

否

String

参数解释：

默认的消费组权限。

约束限制：

不涉及。

取值范围：

  • SUB：拥有订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

topic_perms

否

Array of topic_perms objects

参数解释：

特殊的主题权限。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

group_perms

否

Array of group_perms objects

参数解释：

特殊的消费组权限。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 topic_perms

参数

是否必选

参数类型

描述

name

否

String

参数解释：

主题名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

perm

否

String

参数解释：

Topic权限。

约束限制：

不涉及。

取值范围：

  • PUB：拥有发布权限。

  • SUB：拥有订阅权限。

  • PUB|SUB：拥有发布订阅权限。

  • DENY：无权限。

默认取值：

不涉及。
表4 group_perms

参数

是否必选

参数类型

描述

name

否

String

参数解释：

消费组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

perm

否

String

参数解释：

消费组权限。

约束限制：

不涉及。

取值范围：

  • SUB：拥有订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

access_key

String

参数解释：

用户名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

secret_key

String

参数解释：

密钥。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

white_remote_address

String

参数解释：

IP白名单。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

admin

Boolean

参数解释：

是否为管理员。

约束限制：

不涉及。

取值范围：

  • true：是管理员。

  • false：不是管理员。

默认取值：

不涉及。

default_topic_perm

String

参数解释：

默认的主题权限。

约束限制：

不涉及。

取值范围：

  • PUB：拥有发布权限。

  • SUB：拥有订阅权限。

  • PUB|SUB：拥有发布订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

default_group_perm

String

参数解释：

默认的消费组权限。

约束限制：

不涉及。

取值范围：

  • SUB：拥有订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

topic_perms

Array of topic_perms objects

参数解释：

特殊的主题权限。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

group_perms

Array of group_perms objects

参数解释：

特殊的消费组权限。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表6 topic_perms

参数

参数类型

描述

name

String

参数解释：

主题名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

perm

String

参数解释：

Topic权限。

约束限制：

不涉及。

取值范围：

  • PUB：拥有发布权限。

  • SUB：拥有订阅权限。

  • PUB|SUB：拥有发布订阅权限。

  • DENY：无权限。

默认取值：

不涉及。
表7 group_perms

参数

参数类型

描述

name

String

参数解释：

消费组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

perm

String

参数解释：

消费组权限。

约束限制：

不涉及。

取值范围：

  • SUB：拥有订阅权限。

  • DENY：无权限。

默认取值：

不涉及。

请求示例

修改用户参数，授予user_name用户发布、订阅topic1和group1的权限。

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}

{
  "access_key" : "user_name",
  "secret_key" : "Abcd1234!",
  "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" : "Abcd1234!",
  "topic_perms" : [ ],
  "white_remote_address" : ""
}

状态码

状态码

描述

200

修改成功。

错误码

请参见错误码。

父主题： 用户管理