Nodes

Nodes are worker machines in Kubernetes and may be either a virtual or a physical machine, depending on the cluster. Each Node is managed by the Run:ai control plane. For more information, see Nodes.

Get a list of nodes.

Retrieve a list of nodes from the Kubernetes cluster.

SecuritybearerAuth
Request
path Parameters
clusterUuid
required
string <uuid> non-empty

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc
query Parameters
nodeName
string

The node name.

Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/clusters/{clusterUuid}/nodes
Response samples
application/json
{
  • "nodes": [
    ]
}

Get node telemetry data.

Retrieve node telemetry data for use in analysis applications.

SecuritybearerAuth
Request
query Parameters
clusterId
string <uuid>

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
nodepoolName
string

Filter using the nodepool.

Example: nodepoolName=default
groupBy
Array of strings <= 2 items

workload fields to group the data by

Items Enum: "ClusterId" "Nodepool" "Node"
telemetryType
required
string (NodeTelemetryType)

specifies what data to request

Enum: "READY_GPU_NODES" "READY_GPUS" "TOTAL_GPU_NODES" "TOTAL_GPUS" "FREE_GPUS"
Responses
200

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/nodes/telemetry
Response samples
{
  • "type": "ALLOCATION_RATIO",
  • "timestamp": "2023-06-06 12:09:18.211",
  • "values": [
    ]
}