CreateRabbitMQUser

Download PDF

Last updated: 2025-11-25 10:53:31

CreateRabbitMQUser

Last updated: 2025-11-25 10:53:31

Download PDF

1. API Description

Domain name for API request: tdmq.intl.tencentcloudapi.com.

This API is used to create a TDMQ for RabbitMQ user.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: CreateRabbitMQUser.
Version	Yes	String	Common Params. The value used for this API: 2020-02-17.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID, such as amqp-xxxxxxxx. valid InstanceId can be queried by logging in to the TDMQ RabbitMQ console (https://console.tencentcloud.com/trabbitmq/cluster?rid=1).
User	Yes	String	Username, which is used for login.
Password	Yes	String	Password, used when logging in. requirement: cannot be empty, 8-64 characters, must contain at least two items from lowercase letters, uppercase letters, digits, and special characters [`()~!@#$%^&*_=\|{}[]:;',.?/].
Description	No	String	Description
Tags.N	No	Array of String	User tag, which defines a user's permission scope for accessing RabbitMQ Managementu. Valid values: `management` (Common console user), monitoring` (Console admin user), other values: Non-console user.
MaxConnections	No	Integer	The maximum number of connections for the user. If this parameter is left empty, there's no limit for the number.
MaxChannels	No	Integer	The maximum number of channels for the user. If this parameter is left empty, there's no limit for the number.

3. Output Parameters

Parameter Name	Type	Description
User	String	Username, which is used for login.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a RabbitMQ User

This example shows you how to create a TDMQ for RabbitMQ user.

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRabbitMQUser
<Common request parameters>

{
    "InstanceId": "amqp-2ppxx4rq",
    "User": "test_user",
    "Password": "abc123._"
}

Output Example

{
    "Response": {
        "RequestId": "a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0",
        "User": "test_user"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Incorrect parameter.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud