MENU
      View WorkerNode
        • PDF

        View WorkerNode

        • PDF

        Article summary

        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.

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

        FieldTypeRequiredDescription
        uuidStringRequiredCluster's UUID

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

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

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        nodes[]Array-WorkerNode list
        nodes[].idInteger-WorkerNode ID
        nodes[].nameString-WorkerNode name
        nodes[].serverNameString-Server name
        nodes[].serverSpecString-Server specifications
        nodes[].privateIpString-Private IP
        nodes[].publicIpString-Public IP
        nodes[].returnProtectionYnString-Whether termination protection is set
        nodes[].statusString-Current status
        nodes[].statusCodeString-Status code
        nodes[].statusColorString-Status color
        nodes[].statusNameString-Status name
        nodes[].serverImageNameString-Server image name
        nodes[].cpuCountInteger-Number of CPUs
        nodes[].memorySizeInteger-Total memory capacity
        nodes[].softwareCodeString-Server image code
        nodes[].productCodeString-Product code
        nodes[].specCodeString-@deprecated specifications code
        nodes[].loginKeyNameString-Authentication key name
        nodes[].k8sStatusString-Kubernetes status
        nodes[].dockerVersionString-Docker version
        nodes[].kernelVersionString-Kernel version
        nodes[].nodePoolNameString-NodePool name
        nodes[].nodePoolIdInteger-Nodepool ID
        nodes[].providerIdString-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"
                }
            ]
        }
        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.