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.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| PUT | /vnks/v2/clusters/{uuid}/node-pool/{instanceNo}/labels (Korea Region) |
| PUT | /vnks/sgn-v2/clusters/{uuid}/node-pool/{instanceNo}/labels (Singapore Region) |
| PUT | /vnks/jpn-v2/clusters/{uuid}/node-pool/{instanceNo}/labels (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 UUID
|
instanceNo |
Integer | Required | NodePool instance number |
Request syntax
The request syntax is as follows:
{
"labels": [
{
"key": "string",
"value": "string"
}
]
}
Request body
You can include the following data in the body of your request:
| Field | Type | Required | Description |
|---|---|---|---|
labels |
Array | Required | List of node pool labels to change: labels |
labels
The following describes labels.
| Field | Type | Required | Description |
|---|---|---|---|
key |
String | Required | Node pool label's key
|
value |
String | Required | Node pool label's value
|
Request example
The request example is as follows:
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"
}
]
}'
Response
This section describes the response format.
Response syntax
The response syntax is as follows:
{
"uuid": "string",
"instanceNo": "integer"
}
Response body
The response body includes the following data:
| 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 response example is as follows:
{
"uuid": "1a1111a1-4d44-99b9-88c8-9e99a99e9e99",
"instanceNo": 23323233
}