GET /v1/monitor/node/realtime
Read per-interface or per-resource metric series
- operationId
getNodeRealtimeSeries- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
The contract has no separate permission annotation; see the description below and the 403 response.
Description (from the contract)
Requires nodes.read or platform.admin in a platform scope. Node ownership is checked server-side. Unknown automatic selections produce no bandwidth points, never aggregate fallback values.
Parameters
getNodeRealtimeSeries Parameters| Name | In | Type | Required | Description |
|---|
node | query | string(uuid) | Yes | — |
|---|
type | query | string: bandwidth / connections / load / disk | No | — |
|---|
external_only | query | boolean | No | Literal true or false, at most once. Default false preserves old API callers. The management UI explicitly sends true by default. Filters bandwidth/traffic by each sample's reported network_selection; missing or unavailable selection never means all interfaces. Other metric types are unchanged. False exposes all original NIC facts for manual diagnostics. |
|---|
start | query | string(date-time) | No | Start of a window no longer than 31 days; defaults to one hour ago for realtime and one day ago for traffic. |
|---|
end | query | string(date-time) | No | Defaults to now; must not precede start. |
|---|
limit | query | integer | No | — |
|---|
Responses
getNodeRealtimeSeries Responses| Status | Description |
|---|
200 | Series grouped by NIC or resource; data pairs are UTC epoch milliseconds and values. Fields：msg: string code: integer data: object |
|---|
400 | Invalid parameters; validation_error. |
|---|
401 | Authentication required. |
|---|
403 | Platform scope and nodes.read or platform.admin required. |
|---|
404 | Node absent from the caller scope; node_metrics_not_found. |
|---|
503 | Metrics runtime unavailable; node_metrics_unavailable. |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.404 The resource does not exist or belongs to another tenant.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list
GET /v1/monitor/node/top
Rank node resource metrics
- operationId
getNodeRealtimeTop- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
The contract has no separate permission annotation; see the description below and the 403 response.
Description (from the contract)
Requires nodes.read or platform.admin in a platform scope. Filters precede the limit. No metrics are invented for unknown samples.
Parameters
getNodeRealtimeTop Parameters| Name | In | Type | Required | Description |
|---|
type | query | string: bandwidth / connections / load / disk | No | — |
|---|
external_only | query | boolean | No | Literal true or false, at most once. Default false preserves old API callers. The management UI explicitly sends true by default. Filters bandwidth/traffic by each sample's reported network_selection; missing or unavailable selection never means all interfaces. Other metric types are unchanged. False exposes all original NIC facts for manual diagnostics. |
|---|
recent_time | query | string | No | Must not exceed 31 days. |
|---|
limit | query | integer | No | — |
|---|
Responses
getNodeRealtimeTop Responses| Status | Description |
|---|
200 | Rows sorted by the sum of inbound and outbound resource values, then node name and NIC. Fields：msg: string code: integer data: array<object> |
|---|
400 | Invalid parameters; validation_error. |
|---|
401 | Authentication required. |
|---|
403 | Platform scope and nodes.read or platform.admin required. |
|---|
503 | Metrics runtime unavailable; node_metrics_unavailable. |
|---|
What to do on failure
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.503 A dependency is unavailable: retry later with the original Idempotency-Key.
↑ Back to list