调用ListAllNode,获取集群下的所有节点信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /openapi/instances/[InstanceId]/nodes HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceId String Path es-cn-tl32cpgwa002l****

实例ID。

extended Boolean Query false

是否返回节点的监控信息。可选值:

  • true(默认值):返回。
  • false:不返回。

返回数据

名称 类型 示例值 描述
RequestId String 0D71B597-F3FF-5B56-88D7-74F9D3F7****

请求ID。

Result Array of Result

返回结果。

cpuPercent String 4.2%

CPU使用率。

说明extendedtrue且节点的监控信息在同步时,参数值会返回null,此时需要等待10秒重新发送请求获取该值。
diskUsedPercent String 1.0%

磁盘使用率。

health String GREEN

节点健康状态。支持:GREEN、YELLOW、RED和GRAY。

heapPercent String 21.6%

JVM内存。

host String 10.15.XX.XX

节点IP。

loadOneM String 0.12

一分钟负载。

nodeType String WORKER

节点类型,可选值:

  • MASTER:专有主节点
  • WORKER:热节点
  • WORKER_WARM:冷节点
  • COORDINATING:协调节点
  • KIBANA:Kibana节点
port Integer 9200

节点访问端口。

zoneId String cn-hangzhou-i

节点所在可用区。

示例

请求示例

GET /openapi/instances/es-cn-tl32cpgwa002l****/nodes HTTP/1.1
公共请求头

正常返回示例

JSON格式

{
    "Result": [
        {
            "nodeType": "WORKER",
            "host": "10.15.XX.XX",
            "port": 9200,
            "zoneId": "cn-hangzhou-i",
            "heapPercent": "21.6%",
            "cpuPercent": "4.2%",
            "loadOneM": "0.12",
            "diskUsedPercent": "1.0%",
            "health": "GREEN"
        },
        {
            "nodeType": "WORKER",
            "host": "10.15.XX.XX",
            "port": 9200,
            "zoneId": "cn-hangzhou-i",
            "heapPercent": "23.3%",
            "cpuPercent": "3.6%",
            "loadOneM": "0.04",
            "diskUsedPercent": "1.0%",
            "health": "GREEN"
        },
        {
            "nodeType": "WORKER",
            "host": "10.15.XX.XX",
            "port": 9200,
            "zoneId": "cn-hangzhou-i",
            "heapPercent": "18.3%",
            "cpuPercent": "2.7%",
            "loadOneM": "0.08",
            "diskUsedPercent": "1.0%",
            "health": "GREEN"
        },
        {
            "nodeType": "KIBANA",
            "host": "10.15.XX.XX",
            "port": 5601,
            "zoneId": "cn-hangzhou-i",
            "health": "GREEN"
        }
    ],
    "RequestId": "0D71B597-F3FF-5B56-88D7-74F9D3F7****"
}

错误码

访问错误中心查看更多错误码。