List node ranges

List information about ranges on a specified node. If a list of range IDs is specified, only information about those ranges is returned.

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

GET /nodes/{node_id}/ranges/

cURL

cURL

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

200

{
  "next": 123,
  "ranges": [
    {
      "desc": {
        "end_key": [
          123
        ],
        "queries_per_second": 123,
        "range_id": 123,
        "start_key": [
          123
        ],
        "store_id": 123
      },
      "error_message": "<string>",
      "lease_history": [
        {
          "acquisition_type": 123,
          "deprecated_start_stasis": {
            "logical": 123,
            "synthetic": true,
            "wall_time": 123
          },
          "epoch": 123,
          "expiration": {
            "logical": 123,
            "synthetic": true,
            "wall_time": 123
          },
          "proposed_ts": {
            "logical": 123,
            "synthetic": true,
            "wall_time": 123
          },
          "replica": {
            "node_id": 123,
            "replica_id": 123,
            "store_id": 123,
            "type": 123
          },
          "sequence": 123,
          "start": {
            "logical": 123,
            "synthetic": true,
            "wall_time": 123
          }
        }
      ],
      "problems": {
        "leader_not_lease_holder": true,
        "no_lease": true,
        "no_raft_leader": true,
        "overreplicated": true,
        "quiescent_equals_ticking": true,
        "raft_log_too_large": true,
        "unavailable": true,
        "underreplicated": true
      },
      "quiescent": true,
      "source_node_id": 123,
      "source_store_id": 123,
      "span": {
        "end_key": "<string>",
        "start_key": "<string>"
      },
      "stats": {
        "queries_per_second": 123,
        "writes_per_second": 123
      },
      "ticking": true
    }
  ]
}

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.

Path Parameters

node_id · integer · required

ID of node to query, or local for local node.

Query Parameters

ranges · integer[]

IDs of ranges to return information for. All ranges returned if unspecified.

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

Node ranges response.

next · integer<int64>

Continuation token for the next limited run. Use in the offset parameter.

ranges · Info related to a range. · object[]

Info about retrieved ranges.

Show child attributes