API Reference

NKS

Clusters

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Controllers

Get NKS Controller Details

GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}

List NKS Controllers

GET/v1/nks/clusters/{cluster_id}/controllers

ModelsExpand Collapse

NKSController object { id, created_at, instance_type, 4 more }

NKS controller details.

id: string

Unique identifier for the controller.

created_at: string

When the controller was created.

formatdate-time

instance_type: string

Instance type name.

name: string

Name of the controller.

private_ip: string

Private IP address of the controller.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the controller was last updated.

formatdate-time

NKSControllerList object { items, pagination }

items: array of NKSController { id, created_at, instance_type, 4 more }

id: string

Unique identifier for the controller.

created_at: string

When the controller was created.

formatdate-time

instance_type: string

Instance type name.

name: string

Name of the controller.

private_ip: string

Private IP address of the controller.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

updated_at: string

When the controller was last updated.

formatdate-time

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

ControllersVolumes

Get NKS Controller Volume Details

GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes/{volume_id}

List NKS Controller Volumes

GET/v1/nks/clusters/{cluster_id}/controllers/{controller_id}/volumes

ModelsExpand Collapse

NKSControllerVolume object { id, created_at, kind, 5 more }

NKS controller volume details.

id: string

Unique identifier for the volume.

created_at: string

When the volume was created.

formatdate-time

kind: VolumeKind

Volume kind.

One of the following:

"boot"

"data"

name: string

Name of the volume.

size: number

Size of the volume in GB.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: VolumeType

Type of the Volume.

One of the following:

"nvme"

"abs"

updated_at: string

When the volume was last updated.

formatdate-time

NKSControllerVolumeList object { items, pagination }

items: array of NKSControllerVolume { id, created_at, kind, 5 more }

id: string

Unique identifier for the volume.

created_at: string

When the volume was created.

formatdate-time

kind: VolumeKind

Volume kind.

One of the following:

"boot"

"data"

name: string

Name of the volume.

size: number

Size of the volume in GB.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

type: VolumeType

Type of the Volume.

One of the following:

"nvme"

"abs"

updated_at: string

When the volume was last updated.

formatdate-time

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0