Edit NodePool taint

Prev Next

Available in VPC

Edit taints of a created NodePool. Taint allows you to manage schedulers to avoid using nodes in a particular pod.

Request

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

Method URI
PUT /vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/taints (Korea Region)
PUT /vnks/sgn-v2/clusters/{uuid}/node-pool/{instanceNo}/taints (Singapore Region)
PUT /vnks/jpn-v2/clusters/{uuid}/node-pool/{instanceNo}/taints (Japan Region)

Request headers

For information about the headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service request headers.

Request path parameters

You can use the following path parameters with your request:

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

Request syntax

The request syntax is as follows.

{
  "taints": [
    {
      "key": "string",
      "value": "string",
      "effect": "string"
    }
  ]
}

Request body

The following describes the request body.

Field Type Required Description
taints Array Required List of taints you want to change: taints

taints

The following describes taints.

Field Type Required Description
key String Required Keys in taints
  • English letters, numbers, special characters "-", "_", "." are allowed, and the string must start and end with a English letter or number
value String Optional Values in taints
  • English letters, numbers, special characters "-", "_", "." are allowed, and the string must start and end with a English letter or number
effect String Required Scheduler management method
  • NoSchedule (default) | PreferNoSchedule | NoExecute

Request example

The following is a sample request.

curl --location --request PUT 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/taints' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \
--data '{
  "taints": [
    {
      "key": "taint-key",
      "value": "taint-value",
      "effect": "NoSchedule"
    }
  ]
}'

Response

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 information about the HTTP status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.

Response example

The following is a sample example.

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