View WorkerNode

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

View the list of WorkerNodes registered in the cluster.

Requests

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

Method	URI
GET	/clusters/{uuid}/nodes

Request headers

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

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`uuid`	String	Required	Cluster's UUID Check through View cluster list

Request example

The following is a sample request.

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters/0000a20e-e0fb-4dc9-af1b-97fd3f8d0000/nodes' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account 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.

{
    "nodes": [
        {
            "id": "Integer",
            "name": "String",
            "serverName": "String",
            "serverSpec": "String",
            "privateIp": "String",
            "publicIp": "String",
            "returnProtectionYn": "String",
            "status": "String",
            "statusCode": "String",
            "statusColor": "String",
            "statusName": "String",
            "serverImageName": "String",
            "cpuCount": "Integer",
            "memorySize": "Integer",
            "softwareCode": "String",
            "productCode": "String",
            "specCode": "String",
            "loginKeyName": "String",
            "k8sStatus": "String",
            "dockerVersion": "String",
            "kernelVersion": "String",
            "nodePoolName": "String",
            "nodePoolId": "Integer",
            "providerID": "String"
        }
    ]
}

Response body

The following describes the response body.

Field	Type	Required	Description
`nodes[]`	Array	-	WorkerNode list
`nodes[].id`	Integer	-	WorkerNode ID
`nodes[].name`	String	-	WorkerNode name
`nodes[].serverName`	String	-	Server name
`nodes[].serverSpec`	String	-	Server specifications
`nodes[].privateIp`	String	-	Private IP
`nodes[].publicIp`	String	-	Public IP
`nodes[].returnProtectionYn`	String	-	Whether termination protection is set
`nodes[].status`	String	-	Current status
`nodes[].statusCode`	String	-	Status code
`nodes[].statusColor`	String	-	Status color
`nodes[].statusName`	String	-	Status name
`nodes[].serverImageName`	String	-	Server image name
`nodes[].cpuCount`	Integer	-	Number of CPUs
`nodes[].memorySize`	Integer	-	Total memory capacity
`nodes[].softwareCode`	String	-	Server image code
`nodes[].productCode`	String	-	Product code
`nodes[].specCode`	String	-	@deprecated specifications code
`nodes[].loginKeyName`	String	-	Authentication key name
`nodes[].k8sStatus`	String	-	Kubernetes status
`nodes[].dockerVersion`	String	-	Docker version
`nodes[].kernelVersion`	String	-	Kernel version
`nodes[].nodePoolName`	String	-	NodePool name
`nodes[].nodePoolId`	Integer	-	Nodepool ID
`nodes[].providerId`	String	-	Provider ID

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.

{
    "nodes": [
        {
            "id": 23430000,
            "name": "nodepool01-w-4mnv",
            "serverName": "nodepool01-w-4mnv",
            "serverSpec": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
            "privateIp": "10.0.0.0",
            "publicIp": "223.0.0.0",
            "returnProtectionYn": "Y",
            "status": "RUN",
            "statusCode": "RUN",
            "statusColor": "green",
            "statusName": "Running",
            "serverImageName": "Ubuntu Server 20.04 (64-bit)",
            "cpuCount": 2,
            "memorySize": 8589934592,
            "softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.WRKND.0000",
            "productCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.0000",
            "specCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.0000",
            "loginKeyName": "a123",
            "k8sStatus": "Ready",
            "dockerVersion": "containerd://1.7.12",
            "kernelVersion": "5.4.0-99-generic",
            "nodePoolName": "nodepool01",
            "nodePoolId": 23430000,
            "providerID": "navercloudplatform://23430000"
        }
    ]
}

Was this article helpful?

What's Next

Delete WorkerNode

Table of contents

Requests
Responses