更新时间:2026-04-03 GMT+08:00

查询实例节点

功能介绍

查询实例节点信息。

URI

GET /v2/{project_id}/{engine}/instances/{instance_id}/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

engine

是

String

参数解释:

消息引擎类型。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

nodes

Array of NodeContextEntity objects

参数解释:

后台任务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

total

Integer

参数解释:

总个数。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 NodeContextEntity

参数

参数类型

描述

id

String

参数解释:

ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

broker_name

String

参数解释:

broker名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

broker_id

Integer

参数解释:

broker的ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

address

String

参数解释:

地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

public_address

String

参数解释:

公网地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

GET https://{endpoint}/v2/{project_id}/{engine}/instances/{instance_id}/nodes

响应示例

状态码:200

查询成功。

{
  "total" : 2,
  "nodes" : [ {
    "id" : "node-1",
    "broker_name" : "broker-name-1",
    "broker_id" : "broker-1",
    "address" : "0.0.0.2",
    "public_address" : "1.0.0.2"
  }, {
    "id" : "node-2",
    "broker_name" : "broker-name-2",
    "broker_id" : "broker-2",
    "address" : "0.0.0.1",
    "public_address" : "1.0.0.1"
  } ]
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码。