查询集群节点列表
更新时间:2023-07-05
该接口用于查询指定集群的所有节点信息。
请求结构
GET /v{version}/clusters/{clusterId}/nodes HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其他特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
clusterId | String | 是 | URL参数 | 待查询的集群ID |
marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置,需要设置为节点ID |
maxKeys | int | 否 | Query参数 | 每页包含的最大数量,最大数量不超过1000,缺省值为1000 |
state | String | 否 | Query参数 | 用于指定查询的节点服务状态,具体可选状态参见NodeServiceState。如果不传入该参数,则表示查询所有状态的节点。 |
返回头域
除公共头域外,无其他特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
marker | String | 标记查询的起始位置,与请求接口时传入的marker参数值保持一致 |
maxKeys | int | 每页包含的最大数量,,最大数量不超过1000,缺省值为1000 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 下一页所需要传递的marker值,当isTruncated为false时,该值为null |
nodes | List<Node> | 节点信息列表,由 Node 组成的集合 |
错误码
错误码 | 错误描述 | HTTP状态码 | 描述 |
---|---|---|---|
ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
CLUSTER_HAD_DELETED | 集群已删除 | 451 | 集群已删除 |
CLUSTER_NOT_BELONGED | 未拥有该集群 | 451 | 未拥有该集群 |
CLUSTER_NOT_AVAILABLE | 集群不可用 | 451 | 集群不可用 |
INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
GET http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/nodes
Authorization: bce-auth-v1/ALTAKaiKeDfBD880eMWBE5oIGE/2023-05-08T11:43:45Z/1800/host;x-bce-date/322f3f98ce57d296c0f5abc64e5554b640ea035c5cb462fcaeab54b9810a3c61
Host: kafka-api.bj.baidubce.com
返回示例
HTTP/1.1 200 OK
x-bce-request-id: 97e6d4ad-6fca-4609-ad4d-9a27c4d1a362
Date: Mon, 08 May 2023 09:39:11 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"marker": null,
"isTruncated": false,
"nextMarker": null,
"maxKeys": 1000,
"nodes": [
{
"brokerId": 1,
"host": "instance-5z0qr0qv-1",
"nodeId": "i-PKXSIpnl",
"state": "ALIVE",
"publicIp": null,
"internalIp": "172.18.0.13"
},
{
"brokerId": 2,
"host": "instance-5z0qr0qv-2",
"nodeId": "i-Y0V6vafS",
"state": "ALIVE",
"publicIp": null,
"internalIp": "172.18.0.10"
},
{
"brokerId": 3,
"host": "instance-5z0qr0qv-3",
"nodeId": "i-d6iPVKhf",
"state": "ALIVE",
"publicIp": null,
"internalIp": "172.18.0.15"
}
]
}