› › ›

Get desired nodes API

This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

Get desired nodes.

Request

resp = client.perform_request(
    "GET",
    "/_internal/desired_nodes/_latest",
)
print(resp)

const response = await client.transport.request({
  method: "GET",
  path: "/_internal/desired_nodes/_latest",
});
console.log(response);

GET /_internal/desired_nodes/_latest

Description

This API gets the latest desired nodes.

Examples

This example gets the latest desired nodes.

resp = client.perform_request(
    "GET",
    "/_internal/desired_nodes/_latest",
)
print(resp)

const response = await client.transport.request({
  method: "GET",
  path: "/_internal/desired_nodes/_latest",
});
console.log(response);

GET /_internal/desired_nodes/_latest

The API returns the following result:

{
    "history_id": <history_id>,
    "version": <version>,
    "nodes": [
        {
            "settings": <node_settings>,
            "processors": <node_processors>,
            "memory": "<node_memory>",
            "storage": "<node_storage>"
        }
    ]
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-desired-nodes.html