Creating a User
Function
This API is used to create a user for a RabbitMQ AMQP instance.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/instances/{instance_id}/users
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
access_key |
No |
String |
Username, which starts with a letter, consists of 7 to 64 characters, and contains only letters, digits, hyphens (-), and underscores (_). |
secret_key |
No |
String |
Secret key. 8 to 32 characters. Contain at least three of the following character types:
|
vhosts |
No |
Array of AMQPUserPerm objects |
Virtual hosts to be granted permissions for. Each user can have permissions for multiple virtual hosts. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
vhost |
No |
String |
Name of the virtual host to be granted permissions for. Each user can have permissions for multiple virtual hosts. |
conf |
No |
String |
Granting resource permissions using regular expressions. For example, if you enter ^janeway-.* in the text box, it indicates that the user is authorized to configure all the resources whose names start with janeway- in this virtual host. |
write |
No |
String |
Granting resource write permissions using regular expressions. For example, if you enter .* in the text box, it indicates that the user is authorized to write to all resources in this virtual host. |
read |
No |
String |
Granting resource read permissions using regular expressions. For example, if you enter .* in the text box, it indicates that the user is authorized to read all resources in this virtual host. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
access_key |
String |
Username, which starts with a letter, consists of 7 to 64 characters, and contains only letters, digits, hyphens (-), and underscores (_). |
secret_key |
String |
Secret key. 8 to 32 characters. Contain at least three of the following character types:
|
vhosts |
Array of AMQPUserPerm objects |
Virtual hosts to be granted permissions for. Each user can have permissions for multiple virtual hosts. |
Parameter |
Type |
Description |
---|---|---|
vhost |
String |
Name of the virtual host to be granted permissions for. Each user can have permissions for multiple virtual hosts. |
conf |
String |
Granting resource permissions using regular expressions. For example, if you enter ^janeway-.* in the text box, it indicates that the user is authorized to configure all the resources whose names start with janeway- in this virtual host. |
write |
String |
Granting resource write permissions using regular expressions. For example, if you enter .* in the text box, it indicates that the user is authorized to write to all resources in this virtual host. |
read |
String |
Granting resource read permissions using regular expressions. For example, if you enter .* in the text box, it indicates that the user is authorized to read all resources in this virtual host. |
Example Requests
Creating an AMQP user with permissions for accessing the virtual host default and configuring all resources under the virtual host
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users { "access_key" : "admin123", "secret_key" : "**************", "vhosts" : [ { "vhost" : "default", "conf" : ".*", "write" : ".*", "read" : ".*" } ] }
Example Responses
Status code: 200
Successful
{ "access_key" : "admin123", "secret_key" : "**************", "vhosts" : [ { "vhost" : "default", "conf" : ".*", "write" : ".*", "read" : ".*" } ] }
SDK Sample Code
The SDK sample code is as follows.
Creating an AMQP user with permissions for accessing the virtual host default and configuring all resources under the virtual host
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 |
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.rabbitmq.v2.region.RabbitMQRegion; import com.huaweicloud.sdk.rabbitmq.v2.*; import com.huaweicloud.sdk.rabbitmq.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); RabbitMQClient client = RabbitMQClient.newBuilder() .withCredential(auth) .withRegion(RabbitMQRegion.valueOf("<YOUR REGION>")) .build(); CreateUserRequest request = new CreateUserRequest(); request.withInstanceId("{instance_id}"); AMQPUser body = new AMQPUser(); List<AMQPUserPerm> listbodyVhosts = new ArrayList<>(); listbodyVhosts.add( new AMQPUserPerm() .withVhost("default") .withConf(".*") .withWrite(".*") .withRead(".*") ); body.withVhosts(listbodyVhosts); body.withSecretKey("**************"); body.withAccessKey("admin123"); 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 an AMQP user with permissions for accessing the virtual host default and configuring all resources under the virtual host
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrabbitmq.v2.region.rabbitmq_region import RabbitMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrabbitmq.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 = RabbitMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RabbitMQRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateUserRequest() request.instance_id = "{instance_id}" listVhostsbody = [ AMQPUserPerm( vhost="default", conf=".*", write=".*", read=".*" ) ] request.body = AMQPUser( vhosts=listVhostsbody, secret_key="**************", access_key="admin123" ) 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 an AMQP user with permissions for accessing the virtual host default and configuring all resources under the virtual host
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rabbitmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rabbitmq/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 := rabbitmq.NewRabbitMQClient( rabbitmq.RabbitMQClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateUserRequest{} request.InstanceId = "{instance_id}" vhostVhosts:= "default" confVhosts:= ".*" writeVhosts:= ".*" readVhosts:= ".*" var listVhostsbody = []model.AmqpUserPerm{ { Vhost: &vhostVhosts, Conf: &confVhosts, Write: &writeVhosts, Read: &readVhosts, }, } secretKeyAmqpUser:= "**************" accessKeyAmqpUser:= "admin123" request.Body = &model.AmqpUser{ Vhosts: &listVhostsbody, SecretKey: &secretKeyAmqpUser, AccessKey: &accessKeyAmqpUser, } 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 |
Successful |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot