Run:ai

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

Deprecated - use filterBy instead. The node name; Cannot be used together with filterBy, sort, offset, limit or search query params.

filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-name
sortBy
string (NodeFilterSortFields)

Sort results by a parameters.

Enum: "name" "status" "nodePool" "gpuType" "nvLinkDomainUid" "nvLinkCliqueId"
sortOrder
string
Default: "asc"

Sort results in descending or ascending order.

Enum: "asc" "desc"
offset
integer <int32>

The offset of the first item returned in the collection.

Example: offset=100
limit
integer <int32> [ 1 .. 500 ]
Default: 50

The maximum number of entries to return.

search
string

Filter results by a free text search.

Example: search=test project
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": [
    ]
}

Count nodes

Count nodes

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
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name!=some-name
search
string

Filter results by a free text search.

Example: search=test project
Responses
200

ok

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

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

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": [
    ]
}

Get the node metrics data.

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" "GPU_GRAPHICS_ENGINE_ACTIVITY_PER_GPU" "GPU_SM_ACTIVITY_PER_GPU" "GPU_SM_OCCUPANCY_PER_GPU" "GPU_TENSOR_ACTIVITY_PER_GPU" "GPU_FP64_ENGINE_ACTIVITY_PER_GPU" "GPU_FP32_ENGINE_ACTIVITY_PER_GPU" "GPU_FP16_ENGINE_ACTIVITY_PER_GPU" "GPU_MEMORY_BANDWIDTH_UTILIZATION_PER_GPU" "GPU_NVLINK_TRANSMITTED_BANDWIDTH_PER_GPU" "GPU_NVLINK_RECEIVED_BANDWIDTH_PER_GPU" "GPU_PCIE_TRANSMITTED_BANDWIDTH_PER_GPU" "GPU_PCIE_RECEIVED_BANDWIDTH_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": [
    ]
}
➔ Next to Projects