Get a node by ID. | NVIDIA Run:ai Documentation

{
  "clusterUuid": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "createdAt": "2024-01-15T09:30:00Z",
  "name": "worker-node-1",
  "nodePool": "node-pool-1",
  "status": "Ready",
  "updatedAt": "2024-01-15T09:30:00Z",
  "conditions": [
    {
      "type": "string",
      "reason": "KubeletNotReady",
      "message": "container runtime status check may not have completed yet"
    }
  ],
  "gpuInfo": {
    "gpuType": "Tesla-V100",
    "gpuCount": 1
  },
  "id": "string",
  "networkTopologyLabels": [
    {
      "labelKey": "string",
      "labelValue": "string"
    }
  ],
  "numa": {
    "nodes": [
      {
        "name": "node-0",
        "totalCpuCores": 63.5,
        "allocatedCpuCores": 8.5,
        "totalCpuMemoryBytes": 270582939648,
        "allocatedCpuMemoryBytes": 34359738368,
        "totalGpus": 4,
        "allocatedGpus": 2
      }
    ],
    "topologyManagerPolicy": "none"
  },
  "nvLinkCliqueId": "clique-id",
  "nvLinkDomainUid": "nvlink-domain-uid",
  "taints": [
    {
      "key": "foo",
      "effect": "NoSchedule",
      "value": "bar"
    }
  ]
}

Retrieve a node by its id.

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

nodeIdstringRequiredformat: "uuid">=1 character

The node UUID.

Response

Executed successfully.

clusterUuidstringformat: "uuid"

The id of the cluster.

createdAtdatetime

namestring

The name of the node

nodePoolstring

The node's NodePool.

statusenum

The calculated status of the node.

Allowed values:

updatedAtdatetime

conditionslist of objectsOptional

gpuInfoobjectOptional

idstringOptionalformat: "uuid"

The unique identifier of the node.

networkTopologyLabelslist of objectsOptional

A list of Kubernetes node label key/value pairs that represent the node’s position in the cluster’s network topology (for example, region, zone, block, rack, or hostname). The topology is attached to the node pool on which the workload runs. The label order represents the hierarchy, from farthest (first) to closest (last). These labels are used by the NVIDIA Run:ai Scheduler when making placement decisions.

numaobjectOptional

NUMA configuration and per-NUMA-node resource data for the node.

nvLinkCliqueIdstring or nullOptional

NV Link Clique Id

nvLinkDomainUidstring or nullOptional

NV Link Domain Uid

taintslist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error