CockroachDB · Schema

ListNodesResponse

List of nodes in the CockroachDB cluster with pagination metadata.

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Properties

Name	Type	Description
nodes	array	Array of node status objects.
next	integer	Offset value to use to retrieve the next page of results. Absent when there are no more results.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListNodesResponse",
  "title": "ListNodesResponse",
  "type": "object",
  "description": "List of nodes in the CockroachDB cluster with pagination metadata.",
  "properties": {
    "nodes": {
      "type": "array",
      "description": "Array of node status objects.",
      "items": {
        "$ref": "#/components/schemas/NodeStatus"
      }
    },
    "next": {
      "type": "integer",
      "description": "Offset value to use to retrieve the next page of results. Absent when there are no more results."
    }
  }
}