Get NodePool

Available in VPC

Get the list of NodePools set up to create nodes in a cluster.

Request

This section describes the request format. The method and URI are as follows:

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

Request headers

For headers common to all Ncloud Kubernetes Service APIs, see Common Ncloud Kubernetes Service headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`uuid`	String	Required	Cluster's UUID See Get cluster list.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`hypervisorCode`	String	Optional	Server's hypervisor type `XEN` (default) \| `KVM`

Request example

The request example is as follows:

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

Response

This section 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"
            },
            "fabricCluster": {
              "poolName": "string",
              "poolNo": "integer"
            }
        },
        {
            "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"
            },
            "fabricCluster": {
              "poolName": "string",
              "poolNo": "integer"
            }
        }
    ]
}

Response body

The response body includes the following data:

Field	Type	Required	Description
`nodePool[]`	Array	-	NodePool list: nodePool

`nodePool`

The following describes nodePool.

Field	Type	Required	Description
`instanceNo`	Integer	-	NodePool instance number
`k8sVersion`	String	-	Kubernetes version
`labels`	Array	-	Labels to identify NodePools: labels
`name`	String	-	NodePool name
`nodeCount`	String	-	Number of nodes 1-250
`serverSpecCode`	String	-	Specification code for the NodePool server It is displayed if the hypervisor type of the server is `KVM`.
`softwareCode`	String	-	Server image information
`status`	String	-	Current state of the NodePool
`subnets`	Array	-	List of subnets in the NodePool
`taints`	Array	-	List of taints set for node management in scheduler: taints
`storageSize`	Integer	-	Storage size of the NodePool server
`productCode`	String	-	Spec code for the NodePool server It is displayed if the hypervisor type of the server is `ZEN`
`subnetNameList`	Array	-	List of names in the subnet
`subnetNoList`	Array	-	List of numbers in the subnet
`autoscale`	Array	-	Autoscale information
`autoscale.enabled`	Boolean	-	Auto scaling availability `true` \| `false`
`autoscale.min`	Integer	-	Minimum number of nodes
`autoscale.max`	Integer	-	Maximum number of nodes
`serverRoleId`	String	-	IAM server role ID
`fabricCluster`	Object	-	Fabric cluster information
`fabricCluster.poolName`	String	-	Fabric cluster pool name
`fabricCluster.poolNo`	Integer	-	Fabric cluster pool number

`labels`

The following describes labels.

Field	Type	Required	Description
`key`	String	-	Keys in labels
`value`	String	-	Values in labels

`taints`

The following describes taints.

Field	Type	Required	Description
`key`	String	-	Keys in taints
`effect`	String	-	Scheduler management method `NoSchedule` \| `PreferNoSchedule` \| `NoExecute`
`value`	String	-	Values in taints

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:

{
    "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": [],
            "serverRoleId": "***1fdc0-eb90-11ec-a2d9-246e966eb***",
            "autoscale": {
                "enabled": false
            },
            "fabricCluster": {
              "poolName": "fabric-pool-1",
              "poolNo": 1
            }
        },
        {
            "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
            },
            "fabricCluster": {
              "poolName": "fabric-pool-1",
              "poolNo": 1
            }
        }
    ]
}