VectorSearchInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/scylladb/json-schema/scylladb-vector-search-info-schema.json",
  "title": "VectorSearchInfo",
  "description": "Information about a vector search node in a cluster datacenter",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/scylladb-vector-search-api-openapi.yml#/components/schemas/VectorSearchInfo",
  "type": "object",
  "x-public": true,
  "properties": {
    "availabilityZones": {
      "type": "array",
      "description": "List of availability zones where vector search nodes are deployed",
      "items": {
        "$ref": "#/$defs/AvailabilityZone"
      }
    },
    "status": {
      "$ref": "#/$defs/VectorSearchStatus"
    }
  },
  "$defs": {
    "AvailabilityZone": {
      "type": "object",
      "description": "Details about the availability zone where vector search nodes are deployed",
      "x-public": true,
      "properties": {
        "azid": {
          "type": "string",
          "description": "ID of the availability zone"
        },
        "rackName": {
          "type": "string",
          "description": "Name of the rack"
        },
        "nodes": {
          "type": "array",
          "description": "List of vector search nodes in the availability zone",
          "items": {
            "$ref": "#/$defs/VectorSearchNode"
          }
        }
      }
    },
    "CPUInfo": {
      "type": "object",
      "x-public": true,
      "properties": {
        "usagePercent": {
          "format": "float64",
          "type": "number"
        }
      }
    },
    "MemoryInfo": {
      "type": "object",
      "x-public": true,
      "properties": {
        "freeGiB": {
          "format": "float64",
          "type": "number"
        },
        "usagePercent": {
          "format": "float64",
          "type": "number"
        }
      }
    },
    "VectorSearchNode": {
      "type": "object",
      "description": "Details about the vector search nodes in the rack",
      "x-public": true,
      "properties": {
        "id": {
          "type": "integer",
          "description": "ID of the vector search node"
        },
        "instanceTypeId": {
          "type": "integer",
          "description": "ID of the instance type used for the vector search node"
        },
        "status": {
          "$ref": "#/$defs/VectorSearchNodeStatus"
        },
        "up": {
          "description": "Shows whether the node is up and running.",
          "type": "boolean"
        },
        "cpu": {
          "$ref": "#/$defs/CPUInfo"
        },
        "memory": {
          "$ref": "#/$defs/MemoryInfo"
        },
        "indexCount": {
          "description": "Number of vector search indexes stored on the node.",
          "type": "integer"
        }
      }
    },
    "VectorSearchNodeStatus": {
      "type": "string",
      "description": "Status of the node",
      "x-public": true,
      "enum": [
        "ACTIVE",
        "INACTIVE",
        "PENDING_DELETE",
        "DELETED",
        "QUEUED"
      ]
    },
    "VectorSearchStatus": {
      "x-public": true,
      "enum": [
        "HEALTHY",
        "DEGRADED",
        "UNHEALTHY",
        "UNKNOWN"
      ],
      "type": "string",
      "x-enum-varnames": [
        "vectorSearchStatusHealthy",
        "vectorSearchStatusDegraded",
        "vectorSearchStatusUnhealthy",
        "vectorSearchStatusUnknown"
      ]
    }
  }
}