Couchbase · Schema

Node

Information about a cluster node

AnalyticsApp ServicesBackupCapellaCloudDatabaseDBaaSEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name Type Description
hostname string Node hostname and port
status string Node status
clusterMembership string Cluster membership status
services array List of services running on the node
os string Operating system of the node
version string Couchbase Server version on the node
memoryTotal integer Total memory on the node in bytes
memoryFree integer Free memory on the node in bytes
View JSON Schema on GitHub

JSON Schema

couchbase-node-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Node",
  "title": "Node",
  "type": "object",
  "description": "Information about a cluster node",
  "properties": {
    "hostname": {
      "type": "string",
      "description": "Node hostname and port"
    },
    "status": {
      "type": "string",
      "description": "Node status",
      "enum": [
        "healthy",
        "unhealthy",
        "warmup"
      ]
    },
    "clusterMembership": {
      "type": "string",
      "description": "Cluster membership status",
      "enum": [
        "active",
        "inactiveAdded",
        "inactiveFailed"
      ]
    },
    "services": {
      "type": "array",
      "description": "List of services running on the node",
      "items": {
        "type": "string",
        "enum": [
          "kv",
          "n1ql",
          "index",
          "fts",
          "cbas",
          "eventing",
          "backup"
        ]
      }
    },
    "os": {
      "type": "string",
      "description": "Operating system of the node"
    },
    "version": {
      "type": "string",
      "description": "Couchbase Server version on the node"
    },
    "memoryTotal": {
      "type": "integer",
      "description": "Total memory on the node in bytes"
    },
    "memoryFree": {
      "type": "integer",
      "description": "Free memory on the node in bytes"
    }
  }
}