MENU
      View NodePool
        • PDF

        View NodePool

        • PDF

        Article summary

        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.

        MethodURI
        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.

        FieldTypeRequiredDescription
        uuidStringRequiredCluster's UUID

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        hypervisorCodeStringOptionalServer's hypervisor type
        • XEN (default) | KVM

        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}' \
        Curl

        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"
                    }
                }
            ]
        }
        JSON

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        nodePool[]Array-NodePool list
        nodePool[].instanceNoInteger-NodePool instance number
        nodePool[].k8sVersionString-Kubernetes version
        nodePool[].labels[]String-Labels to identify NodePools
        nodePool[].labels[].keyString-Keys in labels
        nodePool[].labels[].valueString-Values in labels
        nodePool[].nameString-NodePool name
        nodepool.nodeCountString-Number of nodes
        • 1 - 250
        nodePool[].serverSpecCodeString-Spec code for the NodePool server
        • It is displayed if the hypervisor type of the server is KVM
        nodePool[].softwareCodeString-Server image information
        nodePool[].statusString-Current state of the NodePool
        nodePool[].subnetsArray-List of subnets in the NodePool
        nodePool[].taints[]Array-List of taints set for node management in scheduler
        nodePool[].taints[].keyString-Keys in taints
        nodePool[].taints[].effectString-Scheduler management method
        • NoSchedule | PreferNoSchedule | NoExecute
        nodePool[].taints[].valueString-Values in taints
        nodePool[].storageSizeInteger-Storage size of the NodePool server
        nodePool[].productCodeString-Spec code for the NodePool server
        • It is displayed if the hypervisor type of the server is ZEN
        nodePool[].subnetNameList[]Array-List of names in the subnet
        nodePool[].subnetNoList[]Array-List of numbers in the subnet
        nodePool[].autoscaleArray-Autoscale information
        nodePool[].autoscale.enabledBoolean-Auto scaling availability
        • true | false
        nodePool[].autoscale.minInteger-Minimum number of nodes
        nodePool[].autoscale.maxInteger-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
                    }
                }
            ]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.