更新时间:2025-08-15 GMT+08:00
分享

修改用户参数

功能介绍

修改用户参数。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:登录RocketMQ控制台,在RocketMQ实例详情页面查找实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

user_name

String

参数解释

用户名。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

access_key

String

参数解释

用户名。

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

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" : "**************",
  "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" : ""
}

SDK代码示例

SDK代码示例如下。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateUserSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateUserRequest request = new UpdateUserRequest();
        request.withInstanceId("{instance_id}");
        request.withUserName("{user_name}");
        User body = new User();
        List<UserGroupPerms> listbodyGroupPerms = new ArrayList<>();
        listbodyGroupPerms.add(
            new UserGroupPerms()
                .withName("group1")
                .withPerm(UserGroupPerms.PermEnum.fromValue("PUB|SUB"))
        );
        List<UserTopicPerms> listbodyTopicPerms = new ArrayList<>();
        listbodyTopicPerms.add(
            new UserTopicPerms()
                .withName("topic1")
                .withPerm(UserTopicPerms.PermEnum.fromValue("PUB|SUB"))
        );
        body.withGroupPerms(listbodyGroupPerms);
        body.withTopicPerms(listbodyTopicPerms);
        body.withDefaultGroupPerm(User.DefaultGroupPermEnum.fromValue("DENY"));
        body.withDefaultTopicPerm(User.DefaultTopicPermEnum.fromValue("DENY"));
        body.withAdmin(false);
        body.withWhiteRemoteAddress("");
        body.withSecretKey("**************");
        body.withAccessKey("user_name");
        request.withBody(body);
        try {
            UpdateUserResponse response = client.updateUser(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrocketmq.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = RocketMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateUserRequest()
        request.instance_id = "{instance_id}"
        request.user_name = "{user_name}"
        listGroupPermsbody = [
            UserGroupPerms(
                name="group1",
                perm="PUB|SUB"
            )
        ]
        listTopicPermsbody = [
            UserTopicPerms(
                name="topic1",
                perm="PUB|SUB"
            )
        ]
        request.body = User(
            group_perms=listGroupPermsbody,
            topic_perms=listTopicPermsbody,
            default_group_perm="DENY",
            default_topic_perm="DENY",
            admin=False,
            white_remote_address="",
            secret_key="**************",
            access_key="user_name"
        )
        response = client.update_user(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := rocketmq.NewRocketMQClient(
        rocketmq.RocketMQClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateUserRequest{}
	request.InstanceId = "{instance_id}"
	request.UserName = "{user_name}"
	nameGroupPerms:= "group1"
	permGroupPerms:= model.GetUserGroupPermsPermEnum().PUB|SUB
	var listGroupPermsbody = []model.UserGroupPerms{
        {
            Name: &nameGroupPerms,
            Perm: &permGroupPerms,
        },
    }
	nameTopicPerms:= "topic1"
	permTopicPerms:= model.GetUserTopicPermsPermEnum().PUB|SUB
	var listTopicPermsbody = []model.UserTopicPerms{
        {
            Name: &nameTopicPerms,
            Perm: &permTopicPerms,
        },
    }
	defaultGroupPermUser:= model.GetUserDefaultGroupPermEnum().DENY
	defaultTopicPermUser:= model.GetUserDefaultTopicPermEnum().DENY
	adminUser:= false
	whiteRemoteAddressUser:= ""
	secretKeyUser:= "**************"
	accessKeyUser:= "user_name"
	request.Body = &model.User{
		GroupPerms: &listGroupPermsbody,
		TopicPerms: &listTopicPermsbody,
		DefaultGroupPerm: &defaultGroupPermUser,
		DefaultTopicPerm: &defaultTopicPermUser,
		Admin: &adminUser,
		WhiteRemoteAddress: &whiteRemoteAddressUser,
		SecretKey: &secretKeyUser,
		AccessKey: &accessKeyUser,
	}
	response, err := client.UpdateUser(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

修改成功。

错误码

请参见错误码

相关文档