Weaviate · Schema

NodeStatus

The definition of a backup node status response body

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name Type Description
name string The name of the node.
status string Node's status.
version string The version of Weaviate.
gitHash string The gitHash of Weaviate.
stats object
batchStats object
shards array The list of the shards with it's statistics.
operationalMode string Which mode of operation the node is running in.
View JSON Schema on GitHub

JSON Schema

weaviate-node-status-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-node-status-schema.json",
  "title": "NodeStatus",
  "description": "The definition of a backup node status response body",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the node."
    },
    "status": {
      "type": "string",
      "description": "Node's status.",
      "enum": [
        "HEALTHY",
        "UNHEALTHY",
        "UNAVAILABLE",
        "TIMEOUT"
      ],
      "default": "HEALTHY"
    },
    "version": {
      "type": "string",
      "description": "The version of Weaviate."
    },
    "gitHash": {
      "type": "string",
      "description": "The gitHash of Weaviate."
    },
    "stats": {
      "$ref": "#/components/schemas/NodeStats"
    },
    "batchStats": {
      "$ref": "#/components/schemas/BatchStats"
    },
    "shards": {
      "type": "array",
      "description": "The list of the shards with it's statistics.",
      "items": {
        "$ref": "#/components/schemas/NodeShardStatus"
      }
    },
    "operationalMode": {
      "type": "string",
      "description": "Which mode of operation the node is running in.",
      "enum": [
        "ReadWrite",
        "WriteOnly",
        "ReadOnly",
        "ScaleOut"
      ]
    }
  }
}