Edit NodePool label

Prev Next

Available in VPC

Edit labels for a created NodePool. Labels are applied to all nodes in the NodePool, and you can use them to manage the scheduling of nodes.

Requests

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

Method URI
PUT /clusters/{uuid}/node-pool/{instanceNo}/labels

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.

{
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Request body

The following describes the request body.

Field Type Required Description
labels Array Required List of NodePool labels you want to change
labels.key String Required Keys in NodePool labels
  • English letters, numbers, special characters "-", "_", "." are allowed, and the string must start and end with a English letter or number
labels.value String Required Values in NodePool labels
  • English letters, numbers, special characters "-", "_", "." are allowed, and the string must start and end with a English letter or number

Request example

The following is a sample request.

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

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
}