A node (short for worker node) is an abstraction for a Scaleway Instance A node is always part of a pool. Each of them has the Kubernetes software automatically installed and configured by Scaleway.
List Nodes in a Cluster
List all the existing nodes for a specific Kubernetes cluster.
path Parameters
regionThe region you want to target
cluster_idCluster ID from which the nodes will be listed from.
query Parameters
pool_idPool ID on which to filter the returned nodes.
order_bySort order of the returned nodes.
pagePage number for the returned nodes.
page_sizeMaximum number of nodes per page.
nameName to filter on, only nodes containing this substring in their name will be returned.
statusStatus to filter on, only nodes with this status will be returned.
List Nodes in a Cluster › Responses
total_countTotal number of nodes.
Paginated returned nodes.
Get a Node in a Cluster
Retrieve details about a specific Kubernetes Node.
path Parameters
regionThe region you want to target
node_idID of the requested node.
Get a Node in a Cluster › Responses
idNode ID.
pool_idPool ID of the node.
cluster_idCluster ID of the node.
provider_idUnderlying instance ID. It is prefixed by instance type and location information (see https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderIDOpen in new context).
regionCluster region of the node.
nameName of the node.
statusStatus of the node.
error_messageDetails of the error, if any occurred when managing the node.
created_atDate on which the node was created. (RFC 3339 format)
updated_atDate on which the node was last updated. (RFC 3339 format)
Delete a Node in a Cluster
Delete a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.
path Parameters
regionThe region you want to target
node_idID of the node to replace.
query Parameters
skip_drainSkip draining node from its workload (Note: this parameter is currently inactive).
Delete a Node in a Cluster › Responses
idNode ID.
pool_idPool ID of the node.
cluster_idCluster ID of the node.
provider_idUnderlying instance ID. It is prefixed by instance type and location information (see https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderIDOpen in new context).
regionCluster region of the node.
nameName of the node.
statusStatus of the node.
error_messageDetails of the error, if any occurred when managing the node.
created_atDate on which the node was created. (RFC 3339 format)
updated_atDate on which the node was last updated. (RFC 3339 format)
Reboot a Node in a Cluster
Reboot a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur.
path Parameters
regionThe region you want to target
node_idID of the node to reboot.
Reboot a Node in a Cluster › Responses
idNode ID.
pool_idPool ID of the node.
cluster_idCluster ID of the node.
provider_idUnderlying instance ID. It is prefixed by instance type and location information (see https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderIDOpen in new context).
regionCluster region of the node.
nameName of the node.
statusStatus of the node.
error_messageDetails of the error, if any occurred when managing the node.
created_atDate on which the node was created. (RFC 3339 format)
updated_atDate on which the node was last updated. (RFC 3339 format)
Create a Kosmos node
Retrieve metadata for a Kosmos node. This method is not intended to be called by end users but rather programmatically by the kapsule-node-agent.
path Parameters
regionThe region you want to target
pool_idCreate a Kosmos node › Responses
idnamecluster_urlpool_versioncluster_cakube_tokenkubelet_configexternal_ipcontainerd_versionrunc_versioncni_plugins_versioniam_token