View NodePool
- Print
- PDF
View NodePool
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
View the list of NodePools set up to create nodes in a cluster.
Requests
The following describes the request format for the endpoint. The request format is as follows.
| Method | URI |
|---|---|
| GET | /clusters/{uuid}/node-pool |
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
|
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
hypervisorCode | String | Optional | Server's hypervisor type
|
Request example
The following is a sample request.
curl --location 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/node-pool?hypervisorCode=XEN' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \
Responses
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"nodePool": [
{
"instanceNo": "integer",
"k8sVersion": "string",
"labels": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"nodeCount": "integer",
"serverSpecCode": "string",
"softwareCode": "string",
"status": "string",
"subnets": [],
"taints": [
{
"key": "string",
"effect": "string",
"value": "string"
}
],
"storageSize": "integer",
"productCode": "string",
"subnetNameList": [],
"subnetNoList": [],
"autoscale": {
"enabled": "boolean"
}
},
{
"instanceNo": "integer",
"k8sVersion": "string",
"labels": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"nodeCount": "integer",
"serverSpecCode": "string",
"softwareCode": "string",
"status": "string",
"subnets": [],
"taints": [
{
"key": "string",
"effect": "string",
"value": "string"
}
],
"storageSize": "integer",
"productCode": "string",
"subnetNameList": [],
"subnetNoList": [],
"autoscale": {
"enabled": "boolean"
}
}
]
}
Response body
The following describes the response body.
| Field | Type | Required | Description |
|---|---|---|---|
nodePool[] | Array | - | NodePool list |
nodePool[].instanceNo | Integer | - | NodePool instance number |
nodePool[].k8sVersion | String | - | Kubernetes version |
nodePool[].labels[] | String | - | Labels to identify NodePools |
nodePool[].labels[].key | String | - | Keys in labels |
nodePool[].labels[].value | String | - | Values in labels |
nodePool[].name | String | - | NodePool name |
nodepool.nodeCount | String | - | Number of nodes
|
nodePool[].serverSpecCode | String | - | Spec code for the NodePool server
|
nodePool[].softwareCode | String | - | Server image information |
nodePool[].status | String | - | Current state of the NodePool |
nodePool[].subnets | Array | - | List of subnets in the NodePool |
nodePool[].taints[] | Array | - | List of taints set for node management in scheduler |
nodePool[].taints[].key | String | - | Keys in taints |
nodePool[].taints[].effect | String | - | Scheduler management method
|
nodePool[].taints[].value | String | - | Values in taints |
nodePool[].storageSize | Integer | - | Storage size of the NodePool server |
nodePool[].productCode | String | - | Spec code for the NodePool server
|
nodePool[].subnetNameList[] | Array | - | List of names in the subnet |
nodePool[].subnetNoList[] | Array | - | List of numbers in the subnet |
nodePool[].autoscale | Array | - | Autoscale information |
nodePool[].autoscale.enabled | Boolean | - | Auto scaling availability
|
nodePool[].autoscale.min | Integer | - | Minimum number of nodes |
nodePool[].autoscale.max | Integer | - | Maximum number of nodes |
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.
{
"nodePool": [
{
"instanceNo": 00000000,
"k8sVersion": "1.27.9-nks.2",
"labels": [
{
"key": "key",
"value": "value"
}
],
"name": "name",
"serverSpecCode": "s2-g3",
"softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR22.WRKND.G003",
"status": "RUN",
"subnets": [],
"taints": [
{
"key": "key",
"effect": "NoExecute",
"value": "value"
}
],
"storageSize": 100,
"productCode": "SVR.VSVR.STAND.C002.M008.G003",
"subnetNameList": [],
"subnetNoList": [],
"autoscale": {
"enabled": false
}
},
{
"instanceNo": 00000000,
"k8sVersion": "1.27.9-nks.2",
"labels": [
{
"key": "key",
"value": "value"
}
],
"name": "name",
"nodeCount": 3,
"serverSpecCode": "s2-g3",
"softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR22.WRKND.G003",
"status": "RUN",
"subnets": [],
"taints": [
{
"key": "key",
"effect": "NoExecute",
"value": "value"
}
],
"storageSize": 100,
"productCode": "SVR.VSVR.STAND.C002.M008.G003",
"subnetNameList": [],
"subnetNoList": [],
"autoscale": {
"enabled": true,
"min": 1,
"max": 3
}
}
]
}
Was this article helpful?