DescribeRabbitMQUser

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

DescribeRabbitMQUser

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

1. API Description

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

This API is used to query the list of TDMQ for RabbitMQ users.

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: DescribeRabbitMQUser.
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. effective InstanceId can be queried by logging in to the TDMQ RabbitMQ console (https://console.tencentcloud.com/trabbitmq/cluster?rid=1).
SearchUser	No	String	Username search by prefix or suffix
Offset	No	Integer	Specifies the page Offset. default is 0.
Limit	No	Integer	Page Limit. default value: 20.
User	No	String	Username, which is queried by exact match.
Tags.N	No	Array of String	User tag, used to determine the access permission of the user for RabbitMQ Management. management: ordinary console user. monitoring: administrative console user. other value: non-console user.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Returned number of users
RabbitMQUserList	Array of RabbitMQUser	The list of the created TDMQ for RabbitMQ users
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 Querying the RabbitMQ User List

This example shows you how to query the list of TDMQ for RabbitMQ users.

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"
}

Output Example

{
    "Response": {
        "RequestId": "a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0",
        "RabbitMQUserList": [
            {
                "ModifyTime": "2024-06-06 22:46:38.000",
                "CreateTime": "2024-06-06 22:46:38.000",
                "MaxChannels": 1024,
                "MaxConnections": 1000,
                "Type": "1",
                "InstanceId": "amqp-2ppxx4rq",
                "User": "test_user",
                "Password": "Tencent123",
                "Description": "user description",
                "Tags": [
                    "user-tag"
                ]
            }
        ],
        "TotalCount": 1
    }
}

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.
ResourceNotFound	The resource does not exist.

Was this page helpful?

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

Yes

Feedback

tencent cloud