API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

NKS

NKSKubernetes Versions

List NKS Kubernetes Versions

client.NKS.KubernetesVersions.List(ctx, query) (*Cursor[KubernetesVersion], error)

GET/v1/nks/kubernetes_versions

ModelsExpand Collapse

type KubernetesVersion struct{…}

NKS Kubernetes version details.

CreatedAt Time

When the Kubernetes version was created.

formatdate-time

DisplayName string

Display name of the Kubernetes version.

Name string

Name of the Kubernetes version.

NKSClusters

Create NKS Cluster

client.NKS.Clusters.New(ctx, body) (*Operation, error)

POST/v1/nks/clusters

Get NKS Cluster Details

client.NKS.Clusters.Get(ctx, clusterID) (*NKSCluster, error)

GET/v1/nks/clusters/{cluster_id}

Update NKS Cluster

client.NKS.Clusters.Update(ctx, clusterID, body) (*Operation, error)

PATCH/v1/nks/clusters/{cluster_id}

Delete NKS Cluster

client.NKS.Clusters.Delete(ctx, clusterID) (*Operation, error)

DELETE/v1/nks/clusters/{cluster_id}

List NKS Clusters

client.NKS.Clusters.List(ctx, query) (*Cursor[NKSCluster], error)

GET/v1/nks/clusters

ModelsExpand Collapse

type NKSCluster struct{…}

NKS Cluster details.

ID string

Unique identifier for the Cluster.

Autoscaling bool

Whether autoscaling is enabled for the Cluster.

CreatedAt Time

When the Cluster was created.

formatdate-time

KubernetesVersion string

Kubernetes version of the Cluster.

Name string

Name of the Cluster.

PoolIDs []string

IDs of pools belonging to this Cluster.

PrivateIP string

Private IP (VIP) of the Cluster.

ProjectID string

Project ID the Cluster belongs to.

PublicIP string

Public IP of the Cluster.

Region RegionName

Region the resource is in.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Tags []string

Tags attached to the Cluster.

UpdatedAt Time

When the Cluster was last updated.

formatdate-time

VPCID string

ID of the VPC the Cluster is in.

type NKSClusterList struct{…}

Items []NKSCluster

ID string

Unique identifier for the Cluster.

Autoscaling bool

Whether autoscaling is enabled for the Cluster.

CreatedAt Time

When the Cluster was created.

formatdate-time

KubernetesVersion string

Kubernetes version of the Cluster.

Name string

Name of the Cluster.

PoolIDs []string

IDs of pools belonging to this Cluster.

PrivateIP string

Private IP (VIP) of the Cluster.

ProjectID string

Project ID the Cluster belongs to.

PublicIP string

Public IP of the Cluster.

Region RegionName

Region the resource is in.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Tags []string

Tags attached to the Cluster.

UpdatedAt Time

When the Cluster was last updated.

formatdate-time

VPCID string

ID of the VPC the Cluster is in.

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NKSClustersAvailability

Check Create NKS Cluster Availability

client.NKS.Clusters.Availability.New(ctx, body) error

POST/v1/nks/clusters/availability

Check Update NKS Cluster Availability

client.NKS.Clusters.Availability.Update(ctx, clusterID, body) error

PATCH/v1/nks/clusters/{cluster_id}/availability

NKSClustersCost

Estimate NKS Cluster Create Cost

client.NKS.Clusters.Cost.New(ctx, body) (*CostQuote, error)

POST/v1/nks/clusters/cost

Estimate NKS Cluster Update Cost

client.NKS.Clusters.Cost.Update(ctx, clusterID, body) (*CostQuoteUpdate, error)

PATCH/v1/nks/clusters/{cluster_id}/cost

NKSClustersPersistent Volume Claims

Get NKS Persistent Volume Claim Details

client.NKS.Clusters.PersistentVolumeClaims.Get(ctx, clusterID, persistentVolumeClaimID) (*PersistentVolumeClaim, error)

GET/v1/nks/clusters/{cluster_id}/persistent_volume_claims/{persistent_volume_claim_id}

List NKS Persistent Volume Claims

client.NKS.Clusters.PersistentVolumeClaims.List(ctx, clusterID, query) (*Cursor[PersistentVolumeClaim], error)

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

ModelsExpand Collapse

type PersistentVolumeClaim struct{…}

NKS persistent volume claim details.

ID string

Unique identifier for the persistent volume claim.

ClusterID string

Cluster this persistent volume claim belongs to.

CreatedAt Time

When the persistent volume claim was first discovered.

formatdate-time

Name string

Name of the persistent volume claim.

Size int64

Size of the persistent volume claim in GB.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

UpdatedAt Time

When the persistent volume claim was last updated.

formatdate-time

type PersistentVolumeClaimList struct{…}

Items []PersistentVolumeClaim

ID string

Unique identifier for the persistent volume claim.

ClusterID string

Cluster this persistent volume claim belongs to.

CreatedAt Time

When the persistent volume claim was first discovered.

formatdate-time

Name string

Name of the persistent volume claim.

Size int64

Size of the persistent volume claim in GB.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

UpdatedAt Time

When the persistent volume claim was last updated.

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NKSClustersKubeconfig

Get NKS Cluster Kubeconfig

client.NKS.Clusters.Kubeconfig.Get(ctx, clusterID) (*Kubeconfig, error)

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

ModelsExpand Collapse

type Kubeconfig struct{…}

Kubeconfig for an NKS Cluster.

Kubeconfig string

Kubeconfig content for the Cluster.

NKSClustersControllers

Get NKS Controller Details

client.NKS.Clusters.Controllers.Get(ctx, clusterID, controllerID) (*NKSController, error)

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

List NKS Controllers

client.NKS.Clusters.Controllers.List(ctx, clusterID, query) (*Cursor[NKSController], error)

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

ModelsExpand Collapse

type NKSController struct{…}

NKS controller details.

ID string

Unique identifier for the controller.

CreatedAt Time

When the controller was created.

formatdate-time

InstanceType string

Instance type name.

Name string

Name of the controller.

PrivateIP string

Private IP address of the controller.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

UpdatedAt Time

When the controller was last updated.

formatdate-time

type NKSControllerList struct{…}

Items []NKSController

ID string

Unique identifier for the controller.

CreatedAt Time

When the controller was created.

formatdate-time

InstanceType string

Instance type name.

Name string

Name of the controller.

PrivateIP string

Private IP address of the controller.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

UpdatedAt Time

When the controller was last updated.

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NKSClustersControllersVolumes

Get NKS Controller Volume Details

client.NKS.Clusters.Controllers.Volumes.Get(ctx, clusterID, controllerID, volumeID) (*NKSControllerVolume, error)

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

List NKS Controller Volumes

client.NKS.Clusters.Controllers.Volumes.List(ctx, clusterID, controllerID, query) (*Cursor[NKSControllerVolume], error)

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

ModelsExpand Collapse

type NKSControllerVolume struct{…}

NKS controller volume details.

ID string

Unique identifier for the volume.

CreatedAt Time

When the volume was created.

formatdate-time

Kind VolumeKind

Volume kind.

One of the following:

const VolumeKindBoot VolumeKind = "boot"

const VolumeKindData VolumeKind = "data"

Name string

Name of the volume.

Size int64

Size of the volume in GB.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

UpdatedAt Time

When the volume was last updated.

formatdate-time

type NKSControllerVolumeList struct{…}

Items []NKSControllerVolume

ID string

Unique identifier for the volume.

CreatedAt Time

When the volume was created.

formatdate-time

Kind VolumeKind

Volume kind.

One of the following:

const VolumeKindBoot VolumeKind = "boot"

const VolumeKindData VolumeKind = "data"

Name string

Name of the volume.

Size int64

Size of the volume in GB.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

UpdatedAt Time

When the volume was last updated.

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NKSClustersLoad Balancers

Get NKS Load Balancer Details

client.NKS.Clusters.LoadBalancers.Get(ctx, clusterID, loadBalancerID) (*NKSLoadBalancer, error)

GET/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}

Update NKS Load Balancer

client.NKS.Clusters.LoadBalancers.Update(ctx, clusterID, loadBalancerID, body) (*Operation, error)

PATCH/v1/nks/clusters/{cluster_id}/load_balancers/{load_balancer_id}

List NKS Load Balancers

client.NKS.Clusters.LoadBalancers.List(ctx, clusterID, query) (*Cursor[NKSLoadBalancer], error)

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

ModelsExpand Collapse

type NKSLoadBalancer struct{…}

NKS load balancer details.

ID string

Unique identifier for the load balancer.

ClusterID string

Cluster this load balancer belongs to.

CreatedAt Time

When the load balancer was first discovered.

formatdate-time

Namespace string

Kubernetes namespace of the load balancer.

PrivateIP string

Private IP address of the load balancer.

PublicIP string

Public IP address assigned to this load balancer.

PublicIPEnabled bool

Whether a public IP is enabled for this load balancer.

ServiceName string

Kubernetes service name of the load balancer.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

UpdatedAt Time

When the load balancer was last updated.

formatdate-time

type NKSLoadBalancerList struct{…}

Items []NKSLoadBalancer

ID string

Unique identifier for the load balancer.

ClusterID string

Cluster this load balancer belongs to.

CreatedAt Time

When the load balancer was first discovered.

formatdate-time

Namespace string

Kubernetes namespace of the load balancer.

PrivateIP string

Private IP address of the load balancer.

PublicIP string

Public IP address assigned to this load balancer.

PublicIPEnabled bool

Whether a public IP is enabled for this load balancer.

ServiceName string

Kubernetes service name of the load balancer.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

UpdatedAt Time

When the load balancer was last updated.

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NKSClustersPools

Create NKS Node Pool

client.NKS.Clusters.Pools.New(ctx, clusterID, body) (*Operation, error)

POST/v1/nks/clusters/{cluster_id}/pools

Get NKS Node Pool Details

client.NKS.Clusters.Pools.Get(ctx, clusterID, poolID) (*NKSNodePool, error)

GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}

Update NKS Node Pool

client.NKS.Clusters.Pools.Update(ctx, clusterID, poolID, body) (*Operation, error)

PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}

Delete NKS Node Pool

client.NKS.Clusters.Pools.Delete(ctx, clusterID, poolID) (*Operation, error)

DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}

List NKS Node Pools

client.NKS.Clusters.Pools.List(ctx, clusterID, query) (*Cursor[NKSNodePool], error)

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

ModelsExpand Collapse

type NKSNodePool struct{…}

NKS node pool details.

ID string

Unique identifier for the node pool.

ClusterID string

ID of the Cluster this node pool belongs to.

CreatedAt Time

When the node pool was created.

formatdate-time

Name string

Name of the node pool.

NodeConfig NKSNodePoolNodeConfigResponse

Node configuration.

BootVolume NKSNodePoolBootVolumeResponse

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512

minimum64

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

InstanceType string

Instance type name.

Labels []string

Kubernetes labels applied to each node in the pool. Each entry is “key=value”.

Taints []string

Kubernetes taints applied to each node in the pool. Each entry is “key=value:Effect”.

NodeCount int64

Number of nodes.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Tags []string

Tags attached to the node pool.

UpdatedAt Time

When the node pool was last updated.

formatdate-time

type NKSNodePoolBootVolume struct{…}

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512

minimum64

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

type NKSNodePoolBootVolumeResponse struct{…}

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512

minimum64

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

type NKSNodePoolList struct{…}

Items []NKSNodePool

ID string

Unique identifier for the node pool.

ClusterID string

ID of the Cluster this node pool belongs to.

CreatedAt Time

When the node pool was created.

formatdate-time

Name string

Name of the node pool.

NodeConfig NKSNodePoolNodeConfigResponse

Node configuration.

BootVolume NKSNodePoolBootVolumeResponse

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512

minimum64

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

InstanceType string

Instance type name.

Labels []string

Kubernetes labels applied to each node in the pool. Each entry is “key=value”.

Taints []string

Kubernetes taints applied to each node in the pool. Each entry is “key=value:Effect”.

NodeCount int64

Number of nodes.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Tags []string

Tags attached to the node pool.

UpdatedAt Time

When the node pool was last updated.

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

type NKSNodePoolNodeConfig struct{…}

Node configuration.

BootVolume NKSNodePoolBootVolume

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512

minimum64

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

InstanceType string

Instance type name used for worker nodes. Immutable after pool creation.

Labels []stringOptional

Kubernetes labels to apply to each node in the pool. Each entry is “key=value”. Keys under kubernetes.io, k8s.io, and nirvanalabs.io prefixes are reserved. Immutable after pool creation.

Taints []stringOptional

Kubernetes taints to apply to each node in the pool at creation time. Each entry is “key=value:Effect” where Effect is NoSchedule, PreferNoSchedule, or NoExecute. Immutable after pool creation.

type NKSNodePoolNodeConfigResponse struct{…}

Node configuration.

BootVolume NKSNodePoolBootVolumeResponse

Boot volume configuration.

Size int64

Size of the boot volume in GB.

maximum512

minimum64

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

InstanceType string

Instance type name.

Labels []string

Kubernetes labels applied to each node in the pool. Each entry is “key=value”.

Taints []string

Kubernetes taints applied to each node in the pool. Each entry is “key=value:Effect”.

NKSClustersPoolsAvailability

Check Create NKS Node Pool Availability

client.NKS.Clusters.Pools.Availability.New(ctx, clusterID, body) error

POST/v1/nks/clusters/{cluster_id}/pools/availability

Check Update NKS Node Pool Availability

client.NKS.Clusters.Pools.Availability.Update(ctx, clusterID, poolID, body) error

PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}/availability

NKSClustersPoolsCost

Estimate NKS Node Pool Create Cost

client.NKS.Clusters.Pools.Cost.New(ctx, clusterID, body) (*CostQuote, error)

POST/v1/nks/clusters/{cluster_id}/pools/cost

Estimate NKS Node Pool Update Cost

client.NKS.Clusters.Pools.Cost.Update(ctx, clusterID, poolID, body) (*CostQuoteUpdate, error)

PATCH/v1/nks/clusters/{cluster_id}/pools/{pool_id}/cost

NKSClustersPoolsNodes

Get NKS Node Details

client.NKS.Clusters.Pools.Nodes.Get(ctx, clusterID, poolID, nodeID) (*NKSNode, error)

GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}

Delete NKS Node

client.NKS.Clusters.Pools.Nodes.Delete(ctx, clusterID, poolID, nodeID) (*Operation, error)

DELETE/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}

List NKS Nodes

client.NKS.Clusters.Pools.Nodes.List(ctx, clusterID, poolID, query) (*Cursor[NKSNode], error)

GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes

ModelsExpand Collapse

type NKSNode struct{…}

NKS node details.

ID string

Unique identifier for the node.

CreatedAt Time

When the node was created.

formatdate-time

Name string

Name of the node.

PrivateIP string

Private IP address of the node.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

UpdatedAt Time

When the node was last updated.

formatdate-time

type NKSNodeList struct{…}

Items []NKSNode

ID string

Unique identifier for the node.

CreatedAt Time

When the node was created.

formatdate-time

Name string

Name of the node.

PrivateIP string

Private IP address of the node.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

UpdatedAt Time

When the node was last updated.

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NKSClustersPoolsNodesVolumes

Get NKS Node Volume Details

client.NKS.Clusters.Pools.Nodes.Volumes.Get(ctx, clusterID, poolID, nodeID, volumeID) (*NKSNodeVolume, error)

GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes/{volume_id}

List NKS Node Volumes

client.NKS.Clusters.Pools.Nodes.Volumes.List(ctx, clusterID, poolID, nodeID, query) (*Cursor[NKSNodeVolume], error)

GET/v1/nks/clusters/{cluster_id}/pools/{pool_id}/nodes/{node_id}/volumes

ModelsExpand Collapse

type NKSNodeVolume struct{…}

NKS node volume details.

ID string

Unique identifier for the volume.

CreatedAt Time

When the volume was created.

formatdate-time

Kind VolumeKind

Volume kind.

One of the following:

const VolumeKindBoot VolumeKind = "boot"

const VolumeKindData VolumeKind = "data"

Name string

Name of the volume.

Size int64

Size of the volume in GB.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

UpdatedAt Time

When the volume was last updated.

formatdate-time

type NKSNodeVolumeList struct{…}

Items []NKSNodeVolume

ID string

Unique identifier for the volume.

CreatedAt Time

When the volume was created.

formatdate-time

Kind VolumeKind

Volume kind.

One of the following:

const VolumeKindBoot VolumeKind = "boot"

const VolumeKindData VolumeKind = "data"

Name string

Name of the volume.

Size int64

Size of the volume in GB.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Type VolumeType

Type of the Volume.

One of the following:

const VolumeTypeNvme VolumeType = "nvme"

const VolumeTypeABS VolumeType = "abs"

UpdatedAt Time

When the volume was last updated.

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0