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": [{"status": "Ready",
"conditions": [{"type": "string",
"reason": "KubeletNotReady",
"message": "container runtime status check may not have completed yet"
}
],
"taints": [{"key": "foo",
"value": "bar",
"effect": "NoSchedule"
}
],
"nodePool": "node-pool-1",
"createdAt": "2019-08-24T14:15:22Z",
"gpuInfo": {"gpuType": "Tesla-V100",
"gpuCount": 0
},
"name": "worker-node-1",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clusterUuid": "71f69d83-ba66-4822-adf5-55ce55efd210",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

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" "IDLE_ALLOCATED_GPUS" "FREE_GPUS" "ALLOCATED_GPUS" "TOTAL_CPU_CORES" "USED_CPU_CORES" "ALLOCATED_CPU_CORES" "TOTAL_GPU_MEMORY_BYTES" "USED_GPU_MEMORY_BYTES" "TOTAL_CPU_MEMORY_BYTES" "USED_CPU_MEMORY_BYTES" "ALLOCATED_CPU_MEMORY_BYTES"

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": [{"value": "85",
"groups": [{"key": "department",
"value": "1",
"name": "department-A"
}
]
}
]
}

Get the node metrics data. [Experimental]

Retrieve the node metrics data by Universally Unique Identifier (UUID).

SecuritybearerAuth

Request

path Parameters

nodeId

required

string <uuid> non-empty

The node UUID.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc

query Parameters

metricType required	Array of strings (NodeMetricType) Specify which data to request. Items Enum: "GPU_UTILIZATION_PER_GPU" "GPU_UTILIZATION" "GPU_MEMORY_UTILIZATION_PER_GPU" "GPU_MEMORY_UTILIZATION" "GPU_MEMORY_USAGE_BYTES_PER_GPU" "GPU_MEMORY_USAGE_BYTES" "CPU_USAGE_CORES" "CPU_UTILIZATION" "CPU_MEMORY_USAGE_BYTES" "CPU_MEMORY_UTILIZATION" "GPU_OOMKILL_BURST_COUNT_PER_GPU" "GPU_OOMKILL_IDLE_COUNT_PER_GPU" "GPU_OOMKILL_SWAP_OUT_OF_RAM_COUNT_PER_GPU"
start required	string <date-time> Start date of time range to fetch data in ISO 8601 timestamp format. Example: start=2023-06-06T12:09:18.211Z
end required	string <date-time> End date of time range to fetch data in ISO 8601 timestamp format. Example: end=2023-06-07T12:09:18.211Z
numberOfSamples	integer [ 0 .. 1000 ] Default: 20 The number of samples to take in the specified time range. Example: numberOfSamples=20

Responses

200

Executed successfully.

207

Partial success.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/nodes/{nodeId}/metrics

Response samples

{"measurements": [{"type": "ALLOCATED_GPU",
"labels": "{'gpu': '3'}",
"values": [{"value": "85",
"timestamp": "2023-06-06 12:09:18.211"
}
]
}
]
}

➔ Next to Projects