Queries the information of all the nodes in an Elasticsearch cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample codes.

Request parameters

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

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

Request parameters

Parameter Type Location Required Example Description
InstanceId String Path Yes es-cn-tl32cpgwa002l****

The ID of the instance.

extended Boolean Query No false

Specifies whether to return the monitoring information of the node. Valid values:

  • true (default): returns.
  • false: does not return the command outputs.

Response parameters

Parameter Type Example Description
RequestId String 0D71B597-F3FF-5B56-88D7-74F9D3F7****

The ID of the request.

Result Array of Result

The return results.

cpuPercent String 4.2%

The CPU utilization.

diskUsedPercent String 1.0%

The disk usage.

health String GREEN

The health status of the node. Supported: GREEN, YELLOW, RED, and GRAY.

heapPercent String 21.6%

JVM memory.

host String 10.15.XX.XX

The IP address of the node.

loadOneM String 0.12

One-minute load.

nodeType String WORKER

The type of the nodes. Valid values:

  • MASTER: dedicated master node
  • WORKER: hot node
  • WORKER_WARM: cold node
  • COORDINATING: coordination node
  • KIBANA:Kibana node
port Integer 9200

The access port of the node.

zoneId String cn-hangzhou-i

The zone where the node resides.

Examples

Sample requests

GET /openapi/instances/es-cn-tl32cpgwa002l****/nodes HTTP/1.1
Common request headers

Sample success responses

JSON format

{
    "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****"
}

Error codes

For a list of error codes, visit the API Error Center.