Get cluster

Available in VPC

Get specific cluster information.

Request

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

Request headers

For information about the headers common to all Ncloud Kubernetes Service APIs, see Common Ncloud Kubernetes Service request headers.

Request path parameters

You can use the following path parameters with your request:

Request example

The request example is as follows:

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****' \
--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'

Response

This section describes the response format.

Response body

The response body includes the following data:

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:

{
    "cluster": {
        "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": 1600009,
        "capacity": "vCPU 2EA, Memory 8GB",
        "createdAt": "2024-03-28T07:30:59.000Z",
        "updatedAt": "2024-03-28T08:26:33.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": "-",
        "lbPublicSubnetNo": 139000,
        "lbPublicSubnetName": "-",
        "vpcName": "k8s-vpc | 10.0.0.0/16",
        "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": true,
        "authType": "CONFIG_MAP",
        "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
                }
            }
        ]
    }
}