Nodes

Download schema

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

GET

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}/nodes

List all the existing nodes for a specific Kubernetes cluster.

List Nodes in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

cluster_id

string · required

Cluster ID from which the nodes will be listed from.

List Nodes in a Cluster › query Parameters

pool_id

string

Pool ID on which to filter the returned nodes.

order_by

scaleway.k8s.v1.ListNodesRequest.OrderBy · enum

Sort order of the returned nodes.

Enum values:

created_at_asc

created_at_desc

updated_at_asc

updated_at_desc

name_asc

name_desc

status_asc

status_desc

Default: created_at_asc

page

integer · int32

Page number for the returned nodes.

page_size

integer · uint32

Maximum number of nodes per page.

name

string

Name to filter on, only nodes containing this substring in their name will be returned.

status

scaleway.k8s.v1.Node.Status · enum

Status to filter on, only nodes with this status will be returned.

Enum values:

unknown

creating

not_ready

ready

deleting

deleted

locked

rebooting

Default: unknown

List Nodes in a Cluster › Responses

200

scaleway.k8s.v1.ListNodesResponse

total_count

integer · uint64

Total number of nodes.

scaleway.k8s.v1.Node[]

Paginated returned nodes.

Get a Node in a Cluster

GET

https://api.scaleway.com

/k8s/v1/regions/{region}/nodes/{node_id}

Retrieve details about a specific Kubernetes Node.

Get a Node in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

node_id

string · required

ID of the requested node.

Get a Node in a Cluster › Responses

200

scaleway.k8s.v1.Node

id

string

Node ID.

srn

string

The SRN of the node.

pool_id

string

Pool ID of the node.

cluster_id

string

Cluster ID of the node.

provider_id

string

Underlying 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).

region

string

Cluster region of the node.

name

string

Name of the node.

status

scaleway.k8s.v1.Node.Status · enum

Status of the node.

Enum values:

unknown

creating

not_ready

ready

deleting

deleted

locked

rebooting

Default: unknown

error_message

string | null

Details of the error, if any occurred when managing the node.

created_at

string | null · date-time

Date on which the node was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the node was last updated. (RFC 3339 format)

Delete a Node in a Cluster

DELETE

https://api.scaleway.com

/k8s/v1/regions/{region}/nodes/{node_id}

Delete a specific Node. Pool size is reduced by 1. 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.

Delete a Node in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

node_id

string · required

ID of the node to replace.

Delete a Node in a Cluster › query Parameters

skip_drain

boolean · required

Skip draining node from its workload (Note: this parameter is currently inactive).

Delete a Node in a Cluster › Responses

200

scaleway.k8s.v1.Node

id

string

Node ID.

srn

string

The SRN of the node.

pool_id

string

Pool ID of the node.

cluster_id

string

Cluster ID of the node.

provider_id

string

Underlying 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).

region

string

Cluster region of the node.

name

string

Name of the node.

status

scaleway.k8s.v1.Node.Status · enum

Status of the node.

Enum values:

unknown

creating

not_ready

ready

deleting

deleted

locked

rebooting

Default: unknown

error_message

string | null

Details of the error, if any occurred when managing the node.

created_at

string | null · date-time

Date on which the node was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the node was last updated. (RFC 3339 format)

Reboot a Node in a Cluster

POST

https://api.scaleway.com

/k8s/v1/regions/{region}/nodes/{node_id}/reboot

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.

Reboot a Node in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

node_id

string · required

ID of the node to reboot.

Reboot a Node in a Cluster › Request Body

Reboot a Node in a Cluster › Responses

200

scaleway.k8s.v1.Node

id

string

Node ID.

srn

string

The SRN of the node.

pool_id

string

Pool ID of the node.

cluster_id

string

Cluster ID of the node.

provider_id

string

Underlying 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).

region

string

Cluster region of the node.

name

string

Name of the node.

status

scaleway.k8s.v1.Node.Status · enum

Status of the node.

Enum values:

unknown

creating

not_ready

ready

deleting

deleted

locked

rebooting

Default: unknown

error_message

string | null

Details of the error, if any occurred when managing the node.

created_at

string | null · date-time

Date on which the node was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the node was last updated. (RFC 3339 format)

Replace a Node in a Cluster

POST

https://api.scaleway.com

/k8s/v1/regions/{region}/nodes/{node_id}/replace

Replace 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.

Replace a Node in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

node_id

string · required

ID of the node to replace.

Replace a Node in a Cluster › Request Body

Replace a Node in a Cluster › Responses

200

scaleway.k8s.v1.Node

id

string

Node ID.

srn

string

The SRN of the node.

pool_id

string

Pool ID of the node.

cluster_id

string

Cluster ID of the node.

provider_id

string

Underlying 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).

region

string

Cluster region of the node.

name

string

Name of the node.

status

scaleway.k8s.v1.Node.Status · enum

Status of the node.

Enum values:

unknown

creating

not_ready

ready

deleting

deleted

locked

rebooting

Default: unknown

error_message

string | null

Details of the error, if any occurred when managing the node.

created_at

string | null · date-time

Date on which the node was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the node was last updated. (RFC 3339 format)

Pools Versions