Edit NodePool

Prev Next

Available in VPC

Change the number of pinned nodes in an already created node pool or set whether to use autoscaling.

Requests

The following describes the request format for the endpoint. The request format is as follows.

Method URI
PATCH /clusters/{uuid}/node-pool/{instanceNo}

Request headers

For headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service common headers.

Request path parameters

The following describes the parameters.

Field Type Required Description
uuid String Required Cluster's UUID
instanceNo Integer Required NodePool instance number

Request syntax

The request syntax is as follows.

{
  "nodeCount": "integer",
  "autoscale": {
    "enabled": "boolean",
    "max": "integer",
    "min": "integer"
  }
}

Request body

The following describes the request body.

Field Type Required Description
nodeCount Integer Conditional Number of nodes
  • Required when autoscaling is not enabled
autoscale Array Optional Autoscale information
autoscale.enabled Boolean Conditional Autoscale availability
  • true | false
    • true: use autoscale
    • false: not use autoscale
autoscale.max Integer Conditional Maximum number of nodes available for autoscaling
  • Up to 250
  • Required when setting true
autoscale.min Integer Conditional Minimum number of nodes available for autoscaling
  • 1 or more
  • Required when setting true

Request example

The following is a sample request.

curl --location --request PATCH 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \
--data '{
  "nodeCount": 1,
  "autoscale": {
    "enabled": false
  }
}'

Responses

The following describes the response format.

Response syntax

The response syntax is as follows.

{
    "uuid": "string",
    "instanceNo": "integer"
}

Response body

The following describes the response body.

Field Type Required Description
uuid String - UUID of the cluster
instanceNo Integer - NodePool instance number

Response status codes

For response status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.

Response example

The following is a sample response.

{
    "uuid": "1a1111a1-4d44-99b9-88c8-9e99a99e9e99",
    "instanceNo": 23323233
}