List hot ranges - CockroachDB

cURL

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

{
  "next": "<string>",
  "ranges_by_node_id": {},
  "response_error": [
    {
      "error_message": "<string>",
      "node_id": 123
    }
  ]
}

GET

ranges

hot

cURL

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

{
  "next": "<string>",
  "ranges_by_node_id": {},
  "response_error": [
    {
      "error_message": "<string>",
      "node_id": 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

node_id

integer

ID of node to query, or local for local node. If unspecified, all nodes are queried.

limit

integer

Maximum number of results to return in this call.

start

string

Continuation token for results after a past limited run.

Response

200 - application/json

Hot ranges response.

string

Continuation token for the next paginated call. Use as the start parameter.

ranges_by_node_id

object

Show child attributes

response_error

object[]

Show child attributes

List node ranges Get range details