List nodes

List all nodes on this cluster.

Client must be logged in as a user with admin privileges.

GET /nodes/

cURL

cURL

curl --request GET \
  --url https://localhost/api/v2/nodes/ \
  --header 'X-Cockroach-API-Session: <api-key>'

200

{
  "next": 123,
  "nodes": [
    {
      "ServerVersion": {
        "internal": 123,
        "major_val": 123,
        "minor_val": 123,
        "patch": 123
      },
      "address": {
        "address_field": "<string>",
        "network_field": "<string>"
      },
      "attrs": {
        "attrs": [
          "<string>"
        ]
      },
      "build_tag": "<string>",
      "cluster_name": "<string>",
      "liveness_status": 123,
      "locality": {
        "tiers": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      },
      "metrics": {},
      "node_id": 123,
      "num_cpus": 123,
      "sql_address": {
        "address_field": "<string>",
        "network_field": "<string>"
      },
      "started_at": 123,
      "total_system_memory": 123,
      "updated_at": 123
    }
  ]
}

Authorizations

X-Cockroach-API-Session · string · header · required

Token for logged-in REST session. Use /login/ to log in and get a session token. For additional information, see cockroachlabs.com/docs/stable/cluster-api.

Query Parameters

limit · integer

Maximum number of results to return in this call.

offset · integer

Continuation offset for results after a past limited run.

Response

200 - application/json

List nodes response.

next · integer<int64>

Continuation offset for the next paginated call, if more values are present. Specify as the offset parameter.

nodes · Status about a node. · object[]

Status of nodes.

Show child attributes