コンテンツにスキップ

The nodes a poller currently holds, for the Pollers-page drill-down.

GET
/api/v1/pollers/{id}/nodes
curl --request GET \
--url https://example.com/api/v1/pollers/example/nodes \
--header 'Authorization: Bearer <token>'

Served from the coordinator’s published working set rather than a database query, so this and the node detail’s “Polled by” read the same data and can never disagree.

id
required
string

Poller id

limit
integer

The poller’s published working set, capped to one page

Media typeapplication/json

GET /api/v1/pollers/:id/nodes body.

object
nodes
required
Array<object>

One node in the poller drill-down.

object
id
required
string format: uuid
name
required
string
poller_id
required
string
pool

The pool it serves; null unless it is live.

string | null
state
required

assigned (live, working set known), offline (unknown or not beating), or unknown (this core is an HA standby and runs no coordinator).

string
total
required

Nodes in its working set, before the page cap.

integer
truncated
required

Whether nodes is a capped page of total.

boolean
Examplegenerated
{
"nodes": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example"
}
],
"poller_id": "example",
"pool": "example",
"state": "example",
"total": 1,
"truncated": true
}

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Role lacks the View permission

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Skeleton mode: no coordinator to read the working set from

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}