Updated on 2025-08-13 GMT+08:00

Creating a User

Function

This API is used to create a user.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

String

Parameter description:

Instance ID. To obtain it, log in to the RocketMQ console and find the instance ID on the RocketMQ instance details page.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

access_key

No

String

Parameter description:

Username.

Constraints:

Starts with a letter, consists of 7 to 64 characters, and contains only letters, digits, hyphens (-), and underscores (_).

Value range:

N/A

Default value:

N/A

secret_key

No

String

Parameter description:

Secret key.

Constraints:

8 to 32 characters.

Contain at least three of the following character types:

  • Uppercase letters

  • Lowercase letters

  • Digits

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

Cannot be the username or the username spelled backwards.

Value range:

N/A

Default value:

N/A

white_remote_address

No

String

Parameter description:

IP address whitelist.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

admin

No

Boolean

Parameter description:

Whether the user is an administrator.

Constraints:

N/A

Value range:

  • true: yes

  • false: no

Default value:

N/A

default_topic_perm

No

String

Parameter description:

Default topic permissions.

Constraints:

N/A

Value range:

  • PUB: publish permissions.

  • SUB: subscribe permissions.

  • PUB|SUB: subscribe and publish permissions.

  • DENY: no permission.

Default value:

N/A

default_group_perm

No

String

Parameter description:

Default consumer group permissions.

Constraints:

N/A

Value range:

  • SUB: subscribe permissions.

  • DENY: no permission.

Default value:

N/A

topic_perms

No

Array of topic_perms objects

Parameter description:

Special topic permissions.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

group_perms

No

Array of group_perms objects

Parameter description:

Special consumer group permissions.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 3 topic_perms

Parameter

Mandatory

Type

Description

name

No

String

Parameter description:

Topic name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

perm

No

String

Parameter description:

Topic permission.

Constraints:

N/A

Value range:

  • PUB: publish permissions.

  • SUB: subscribe permissions.

  • PUB|SUB: subscribe and publish permissions.

  • DENY: no permission.

Default value:

N/A

Table 4 group_perms

Parameter

Mandatory

Type

Description

name

No

String

Parameter description:

Consumer group name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

perm

No

String

Parameter description:

Consumer group permissions.

Constraints:

N/A

Value range:

  • SUB: subscribe permissions.

  • DENY: no permission.

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

access_key

String

Parameter description:

Username.

Value range:

N/A

secret_key

String

Parameter description:

Secret key.

Value range:

N/A

white_remote_address

String

Parameter description:

IP address whitelist.

Value range:

N/A

admin

Boolean

Parameter description:

Whether the user is an administrator.

Value range:

  • true: yes

  • false: no

default_topic_perm

String

Parameter description:

Default topic permissions.

Value range:

  • PUB: publish permissions.

  • SUB: subscribe permissions.

  • PUB|SUB: subscribe and publish permissions.

  • DENY: no permission.

default_group_perm

String

Parameter description:

Default consumer group permissions.

Value range:

  • SUB: subscribe permissions.

  • DENY: no permission.

topic_perms

Array of topic_perms objects

Parameter description:

Special topic permissions.

Value range:

N/A

group_perms

Array of group_perms objects

Parameter description:

Special consumer group permissions.

Value range:

N/A

Table 6 topic_perms

Parameter

Type

Description

name

String

Parameter description:

Topic name.

Value range:

N/A

perm

String

Parameter description:

Topic permission.

Value range:

  • PUB: publish permissions.

  • SUB: subscribe permissions.

  • PUB|SUB: subscribe and publish permissions.

  • DENY: no permission.

Table 7 group_perms

Parameter

Type

Description

name

String

Parameter description:

Consumer group name.

Value range:

N/A

perm

String

Parameter description:

Consumer group permissions.

Value range:

  • SUB: subscribe permissions.

  • DENY: no permission.

Example Requests

Creating a non-administrator user with permissions to publish and subscribe to topic1 and 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"
  } ]
}

Example Responses

Status code: 200

The creation is successful.

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

SDK Sample Code

The SDK sample code is as follows.

Creating a non-administrator user with permissions to publish and subscribe to topic1 and 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
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 CreateUserSolution {

    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();
        CreateUserRequest request = new CreateUserRequest();
        request.withInstanceId("{instance_id}");
        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 {
            CreateUserResponse response = client.createUser(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());
        }
    }
}

Creating a non-administrator user with permissions to publish and subscribe to topic1 and 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
# 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 = CreateUserRequest()
        request.instance_id = "{instance_id}"
        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.create_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)

Creating a non-administrator user with permissions to publish and subscribe to topic1 and 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
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.CreateUserRequest{}
	request.InstanceId = "{instance_id}"
	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.CreateUser(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The creation is successful.

Error Codes

See Error Codes.