v1

latestSwagger 2.02026-08-04232286653.5 KB

Kubernetes Node Pools

Returns details for a single Kubernetes node pool in the project.

get/projects/{project_id}/kubernetes/nodepools/{node_pool_id}

Path parameters

project_idstring required

ID of the project that owns the node pool.

node_pool_idstring required

ID of the node pool.

Response

cluster_idstring required

ID of the Kubernetes cluster the node pool belongs to.

countinteger required

Number of nodes in the node pool.

created_atstring required

Creation timestamp of the node pool, in RFC3339 format.

ephemeral_storage_for_containerdboolean required

Whether the first local ephemeral NVMe disk is used for containerd storage.

idstring required

ID of the node pool.

image_idstring required

ID of the image used for the node pool.

instance_idsstring[] required

IDs of the instances within the node pool.

namestring required

Name of the node pool.

node_labelsobject required

Labels assigned to nodes in the node pool.

nvlink_domain_idstring

NVLink domain ID assigned to the node pool.

project_idstring required

ID of the project that owns the node pool.

public_ip_typestring

Public IP type for the node pool's nodes: dynamic, static, or none.

reservation_idstring required

ID of the billing reservation associated with the node pool.

statestring required

Current state of the node pool.

subnet_idstring required

ID of the subnet the node pool belongs to.

typestring required

VM type of the node pool.

updated_atstring required

Last update timestamp of the node pool, in RFC3339 format.

Example response

{
  "cluster_id": "9c8b7d6e-5f4a-3b2c-1e0f-2a3b4c5d6e7f",
  "count": 4,
  "created_at": "2021-12-03T19:58:34Z",
  "ephemeral_storage_for_containerd": true,
  "id": "0a1b3c2d-5e6f-8b9c-4d7e-1a2b3c4d5e6f",
  "image_id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
  "instance_details": [
    {
      "id": "ca39e669-47ee-456b-968d-303234fbf99f",
      "using_latest_config": true
    }
  ],
  "instance_ids": [
    "ca39e669-47ee-456b-968d-303234fbf99f"
  ],
  "name": "crusoe-node-pool",
  "node_labels": {
    "label": "my_node"
  },
  "node_taints": [
    {
      "effect": "NoSchedule",
      "key": "gpu",
      "value": "true"
    }
  ],
  "nvlink_domain_id": "550e8400-e29b-41d4-a716-446655440000",
  "project_id": "9c8b7d6e-5f4a-3b2c-1e0f-2a3b4c5d6e7f",
  "public_ip_type": "dynamic",
  "reservation_id": "ca39e669-47ee-456b-968d-303234fbf99f",
  "state": "STATE_RUNNING",
  "subnet_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
  "type": "a100.2x",
  "updated_at": "2021-12-03T19:58:34Z"
}