DescribeRabbitMQNodeList

Prev Next

请输入关键字

Recent Pages

文档

Download PDF

DescribeRabbitMQNodeList

最后更新时间：2023-04-18 14:53:13

下载PDF

1. API Description

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

This API is used to query the list of TDMQ for RabbitMQ exclusive cluster nodes.

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: DescribeRabbitMQNodeList.
Version	Yes	String	Common Params. The value used for this API: 2020-02-17.
Region	No	String	Common Params. This parameter is not required for this API.
InstanceId	Yes	String	TDMQ for RabbitMQ cluster ID
Offset	No	Integer	Offset
Limit	No	Integer	The maximum entries per page
NodeName	No	String	Node name for fuzzy search
Filters.N	No	Array of Filter	Name and value of a filter. Currently, only the `nodeStatus` filter is supported. Valid values: `running`, `down`. It is an array type and can contain multiple filters.
SortElement	No	String	Sorting by a specified element. Valid values: `cpuUsage`, `diskUsage`.
SortOrder	No	String	Sorting order. Valid values: `ascend`, `descend`.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	The number of clusters
NodeList	Array of RabbitMQPrivateNode	Cluster list Note: This field may return null, indicating that no valid value can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of TDMQ for RabbitMQ exclusive cluster nodes

This example shows you how to query the list of TDMQ for RabbitMQ exclusive cluster nodes.

Input Example

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

{
    "InstanceId": "amqp-testtesttest",
    "Limit": 1,
    "Offset": 1
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "NodeList": [
            {
                "NodeName": "xx"
            }
        ]
    }
}

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

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

DescribeRabbitMQNodeList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the list of TDMQ for RabbitMQ exclusive cluster nodes

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

DescribeRabbitMQNodeList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the list of TDMQ for RabbitMQ exclusive cluster nodes

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？