修改用户参数
功能介绍
修改用户参数。
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
String |
参数解释： 实例ID。获取方法如下：登录RocketMQ控制台，在RocketMQ实例详情页面查找实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
user_name |
是 |
String |
参数解释： 用户名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
参数解释： 特殊的消费组权限。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释： 特殊的消费组权限。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求示例
修改用户参数，授予user_name用户发布、订阅topic1和group1的权限。
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}
{
"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 |
修改成功。 |
错误码
请参见错误码。
