Get network topology by id. | NVIDIA Run:ai Documentation

{
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "levels": [
    "cloud.provider.com/topology-block",
    "cloud.provider.com/topology-rack",
    "kubernetes.io/hostname"
  ],
  "name": "default-topology",
  "tenantId": 1001,
  "createdBy": "user@lab.com",
  "groveTopology": {
    "name": "string",
    "domains": [
      "string"
    ],
    "conditions": [
      {
        "type": "string",
        "status": "string",
        "reason": "string",
        "message": "string",
        "observedGeneration": 1
      }
    ]
  },
  "nodePools": [
    "a100"
  ],
  "phase": "Ready",
  "source": "control-plane"
}

Retrieve network topology details by Universally Unique Identifier (UUID).

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

networkTopologyIdstringRequiredformat: "uuid"

The unique identifier for the network topology

Response

Executed successfully.

clusterIdstringformat: "uuid"

The id of the cluster.

createdAtdatetime

The timestamp for when the network topology was created

idstringformat: "uuid"

The unique identifier for the network topology

levelslist of strings

Ordered array of network topology levels

namestringformat: "^[a-z]([a-z0-9-]*[a-z0-9])?$"1-63 characters

Name of the network topology

tenantIdinteger

The id of the tenant.

createdBystringOptional

Identifier of the user who created the network topology

groveTopologyobjectOptional

The linked Grove topology definition. Null if no Grove topology has been linked to this network topology

nodePoolslist of strings or nullOptionalRead-only

List of node-pools associated with this network topology

phasestringOptional

Phase of the network topology in the cluster. Enum: Creating, Ready

sourcestringOptionalformat: "^[a-zA-Z0-9][a-zA-Z0-9_.-]*[a-zA-Z0-9]$"1-63 characters

Identifier of the source of the topology. Useful for tracking where the topology data originated (e.g. control-plane, cluster).

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error