1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
RabbitMQ专享版查询节点列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRabbitMQNodeList。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | rabbitmq集群ID 示例值：amqp-xxx |
| Offset | 否 | Integer | 偏移量 示例值：1 |
| Limit | 否 | Integer | 一页限制 示例值：20 |
| NodeName | 否 | String | 模糊搜索节点名字 示例值：node-xxx |
| Filters.N | 否 | Array of Filter | 过滤参数的名字和数值 现在只有一个nodeStatus running/down 数组类型，兼容后续添加过滤参数 示例值：nodeStatus running/down |
| SortElement | 否 | String | 按指定元素排序，现在只有2个 cpuUsage/diskUsage 示例值：cpuUsage/diskUsage |
| SortOrder | 否 | String | 升序/降序 ascend/descend 示例值：ascend/descend |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 集群列表数量 示例值：1 |
| NodeList | Array of RabbitMQPrivateNode | 集群列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 RabbitMQ专享版查询节点列表
RabbitMQ专享版查询节点列表 在查询节点的时候使用。
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRabbitMQNodeList
<公共请求参数>
{
"InstanceId": "amqp-test",
"Offset": 0,
"Limit": 3,
"NodeName": "rabbit@rabbitmq-broker-1.rabbitmq-broker-internal.amqp-test.svc.cluster.local",
"Filters": [
{
"Name": "nodeStatus",
"Values": [
"running"
]
}
],
"SortElement": "cpuUsage",
"SortOrder": "descend"
}输出示例
{
"Response": {
"NodeList": [
{
"CPUUsage": "0.000%",
"DiskUsage": "3.000%",
"Memory": 171,
"NodeName": "rabbit@rabbitmq-broker-1.rabbitmq-broker-internal.amqp-test.svc.cluster.local",
"NodeStatus": "running",
"ProcessNumber": 459
}
],
"RequestId": "a95bfcfd-8388-4f86-8511-ca3be8ed000c",
"TotalCount": 1
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| ResourceNotFound.Cluster | 集群不存在。 |
