Skip to main content

REST - /v1/nodes

LICENSE Weaviate on Stackoverflow badge Weaviate issues on Github badge Weaviate version badge Weaviate total Docker pulls badge Go Report Card

Usage

The nodes endpoint accepts a GET request:

GET /v1/nodes

And it returns a nodes field containing array of nodes with following fields:

  • name: Name of the node.
  • status: Status of the node (one of: HEALTHY, UNHEALTHY, UNAVAILABLE).
  • version: Version of Weaviate running on the node.
  • gitHash: Short git hash of latest commit of Weaviate running on the node.
  • stats: Statistics of the node with following fields:
    • shardCount: Total number of shards on the node.
    • objectCount Total number of objects on the node.
  • shards: Array of shards with following fields:
    • name: Name of the shard.
    • class: Name of the objects' class stored on the shard.
    • objectCount: Number of objects on the shard.

Example

The following command:

import weaviate

client = weaviate.Client("http://localhost:8080")

nodes_status = client.cluster.get_nodes_status()
print(nodes_status)

returns:

{
"nodes": [
{
"name": "weaviate-7",
"status": "HEALTHY",
"version": "1.16-alpha.0",
"gitHash": "8cd2efa",
"stats": {
"shardCount":2,
"objectCount": 23328
},
"shards": [
{
"name":"azuawSAd9312F",
"class": "Class_7",
"objectCount": 13328
}, {
"name":"cupazAaASdfPP",
"class": "Foo",
"objectCount": 10000
}
]
}, {
"name": "weaviate-6",
"status": "HEALTHY",
"version": "1.16-alpha.0",
"gitHash": "8cd2efa",
"stats": {
"shardCount":2,
"objectCount": 12345
},
"shards": [
{
"name":"hh8gXiaNaO2K",
"class": "Bar",
"objectCount": 10000
}, {
"name":"zmb16QK4PYZ4",
"class": "Baz",
"objectCount": 2345
}
]
}
]
}

More Resources

If you can't find the answer to your question here, please look at the:

  1. Frequently Asked Questions. Or,
  2. Knowledge base of old issues. Or,
  3. For questions: Stackoverflow. Or,
  4. For issues: Github. Or,
  5. Ask your question in the Slack channel: Slack.