MENU
      Get cluster list
        • PDF

        Get cluster list

        • PDF

        Article summary

        Available in VPC

        Get the cluster list.

        Request

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

        MethodURI
        GET/clusters

        Request headers

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

        Request example

        The following is a sample request.

        curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters' \
        --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}' \
        --header 'Content-Type: application/json'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
            "clusters": [
                {
                    "cpuCount": "Integer",
                    "memorySize": "Integer",
                    "status": "String",
                    "nodeCount": "Integer",
                    "nodeMaxCount": "Integer",
                    "clusterType": "String",
                    "hypervisorCode": "String",
                    "instanceNo": "Integer",
                    "id": "Integer",
                    "acgName": "String",
                    "acgNo": "Integer",
                    "capacity": "String",
                    "createdAt": "String",
                    "updatedAt": "String",
                    "endpoint": "String",
                    "uuid": "String",
                    "name": "String",
                    "k8sVersion": "String",
                    "regionCode": "String",
                    "kubeNetworkPlugin": "String",
                    "vpcNo": "Integer",
                    "subnetNoList": [
                        "Integer"
                    ],
                    "subnetLbNo": "Integer",
                    "lbPrivateSubnetNo": "Integer",
                    "lbPrivateSubnetName": "String",
                    "lbPublicSubnetNo": "Integer",
                    "lbPublicSubnetName": "String",
                    "vpcName": "String",
                    "subnetName": "String",
                    "subnetNameList": [
                        "String"
                    ],
                    "subnetLbName": "String",
                    "loginKeyName": "String",
                    "zoneCode": "String",
                    "zoneNo": "Integer",
                    "log": {
                        "audit": "Boolean"
                    },
                    "publicNetwork": "Boolean",
                    "iamAuth": "Boolean",
                    "isDefaultIamAuth": "Boolean",
                    "returnProtection": "Boolean",
                    "kmsKeyTag": "String",
                    "nodePool": [
                        {
                            "instanceNo": "Integer",
                            "k8sVersion": "String",
                            "name": "String",
                            "nodeCount": "Integer",
                            "subnetNoList": [],
                            "subnetNameList": [],
                            "softwareCode": "String",
                            "productCode": "String",
                            "serverSpecCode": "String",
                            "storageSize": "Integer",
                            "status": "String",
                            "autoscale": {
                                "enabled": "Boolean",
                                "min": "Integer",
                                "max": "Integer"
                            }
                        }
                    ]
                }
            ]
        }
        JSON

        Response body

        The response syntax is as follows.

        FieldTypeRequiredDescription
        clusters[]Array-Cluster list
        clusters[].cpuCountInteger-Number of CPUs
        clusters[].memorySizeInteger-Total memory capacity
        clusters[].statusString-Cluster status
        clusters[].nodeCountInteger-Total number of nodes registered
        clusters[].nodeMaxCountInteger-Maximum number of available nodes
        clusters[].clusterTypeString-Cluster type
        clusters[].hypervisorCodeString-Hypervisor code
        clusters[].instanceNoInteger-Instance number
        clusters[].idInteger-Cluster ID
        clusters[].acgNameString-ACG name
        clusters[].acgNoInteger-ACG number
        clusters[].capacityString-Cluster capacity
        clusters[].createdAtString-Cluster creation date and time
        clusters[].updatedAtString-Last update date and time
        clusters[].endpointString-Control Plane API address
        clusters[].uuidString-Cluster UUID
        clusters[].nameString-Cluster name
        clusters[].k8sVersionString-Kubernetes version
        clusters[].regionCodeString-Region code
        clusters[].kuberNetworkPluginString-CNI plugin code
        clusters[].vpcNoInteger-VPC ID
        clusters[].subnetNoList[]Array-Subnet ID list
        clusters[].subnetLbNoInteger-@deprecated Load Balancer-only subnet ID
        clusters[].lbPivateSubnetNoInteger-Load balancer private subnet ID
        clusters[].lbPivateSubnetNameString-Load balancer private subnet name
        clusters[].lbPublicSubnetNoInteger-Load balancer private subnet number
        clusters[].lbPublicSubnetNameString-Load balancer private subnet name
        clusters[].vpcNameString-VPC name
        clusters[].subnetNameString-@deprecated Subnet name
        clusters[].subentNameList[]Array-
        clusters[].subnetLbNameString-@deprecated Load Balancer-only subnet name
        clusters[].loginKeyNameString-Authentication key name
        clusters[].zoneCodeString-Zone code
        clusters[].zoneNoInteger-Zone number
        clusters[].logArray-Log list
        clusters[].log.auditBoolean-Set audit log
        clusters[].publicNetworkBoolean-Public Network
        clusters[].iamAuthBoolean-
        clusters[].isDefaultIamAuthBoolean-
        clusters[].returnProtectionBoolean-
        clusters[].kmsKeyTagString-
        clusters[].nodePool[]Array-NodePool list
        clusters[].nodePool[].instanceNoInteger-NodePool instance number
        clusters[].nodePool[].k8sVersionString-NodePool Kubernetes version
        clusters[].nodePool[].nameString-NodePool name
        clusters[].nodePool[].nodeCountInteger-Number of nodes
        clusters[].nodePool[].subnetNoList[]Array-NodePool subnet number list
        clusters[].nodePool[].subnetNameList[]Array-@deprecated NodePool subnet name list
        clusters[].nodePool[].softwareCodeString-Software code
        clusters[].nodePool[].productCodeString-Product code
        clusters[].nodePool[].serverSpecCodeString-Server specification code
        clusters[].nodePool[].storageSizeInteger-Storage size
        clusters[].nodePool[].statusString-NodePool status
        clusters[].nodePool[].autoscaleArray-Autoscaling list
        clusters[].nodePool[].autoscale.enabledBoolean-
        clusters[].nodePool[].autoscale.minInteger-
        clusters[].nodePool[].autoscale.maxInteger-
        clusters[].nodePool[].serverRoleIdString-IAM server role 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 example.

        {
            "clusters": [
                {
                    "cpuCount": 2,
                    "memorySize": 8,
                    "status": "RUNNING",
                    "nodeCount": 1,
                    "nodeMaxCount": 1,
                    "clusterType": "AAA.VNKS.STAND.C002.M008.G000",
                    "hypervisorCode": "KVM",
                    "instanceNo": 23320000,
                    "id": 14000,
                    "acgName": "nks-14000-acgname",
                    "acgNo": 160009,
                    "capacity": "vCPU 2EA, Memory 8GB",
                    "createdAt": "2024-03-28T07:30:59.000Z",
                    "updatedAt": "2024-03-28T07:47:53.000Z",
                    "endpoint": "https://****a20e-e0fb-4dc9-af1b-97fd3f8d****.kr.vnks.ntruss.com",
                    "uuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****",
                    "name": "cluster00",
                    "k8sVersion": "1.27.9-nks.2",
                    "regionCode": "KR",
                    "kubeNetworkPlugin": "cilium",
                    "vpcNo": 59000,
                    "subnetNoList": [
                        139000
                    ],
                    "subnetLbNo": 139000,
                    "lbPrivateSubnetNo": 139000,
                    "lbPrivateSubnetName": "k8s-lbsubnet2 | KR-1 | 0.0.0.0/0 | Private",
                    "lbPublicSubnetNo": 139000,
                    "lbPublicSubnetName": "k8s-lbsubnet | KR-1 | 0.0.0.0/0 | Public",
                    "vpcName": "k8s-vpc | 0.0.0.0/0",
                    "subnetName": "k8s-subnet",
                    "subnetNameList": [
                        "k8s-subnet | KR-1 | 0.0.0.0/0 | Public"
                    ],
                    "subnetLbName": "k8s-lbsubnet2 | KR-1 | 0.0.0.0/0 | Private",
                    "loginKeyName": "a123",
                    "zoneCode": "KR-1",
                    "zoneNo": 2,
                    "log": {
                        "audit": false
                    },
                    "publicNetwork": true,
                    "iamAuth": true,
                    "isDefaultIamAuth": true,
                    "returnProtection": false,
                    "kmsKeyTag": "****83e65495374b9cf590a783f442fd50eb48c54eb56774de1ff62bcda4****",
                    "nodePool": [
                        {
                            "instanceNo": 23320000,
                            "k8sVersion": "1.27.9",
                            "name": "nodepool",
                            "nodeCount": 1,
                            "subnetNoList": [],
                            "subnetNameList": [],
                            "softwareCode": "SW.AAAA.OS.LNX64.UBNTU.SVR22.WRKND.AAAA",
                            "productCode": "SVR.AAAA.STAND.C002.M008.AAAA",
                            "serverSpecCode": "s2-g3",
                            "storageSize": 100,
                            "status": "RUN",
                            "serverRoleId": "***1fdc0-eb90-11ec-a2d9-246e966eb***",
                            "autoscale": {
                                "enabled": false,
                                "min": 0,
                                "max": 0
                            }
                        }
                    ]
                }
            ]
        }
        JSON

        Was this article helpful?

        What's Next
        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.