Get cluster

Available in VPC

Get specific cluster information.

Request

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

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

Request headers

For information about the headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service request 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 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:

Field	Type	Required	Description
`cluster`	Object	-	Cluster information
`cluster.cpuCount`	Integer	-	Number of CPUs
`cluster.memorySize`	Integer	-	Total memory capacity
`cluster.status`	String	-	Cluster status
`cluster.nodeCount`	Integer	-	Total number of nodes registered
`cluster.nodeMaxCount`	Integer	-	Maximum number of available nodes
`cluster.clusterType`	String	-	Cluster type
`cluster.hypervisorCode`	String	-	Hypervisor code
`cluster.instanceNo`	Integer	-	Instance number
`cluster.id`	Integer	-	Cluster ID
`cluster.acgName`	String	-	ACG name
`cluster.acgNo`	Integer	-	ACG number
`cluster.capacity`	String	-	Cluster capacity
`cluster.createdAt`	String	-	Cluster creation date and time
`cluster.updatedAt`	String	-	Last update date and time
`cluster.endpoint`	String	-	Control Plane API address
`cluster.uuid`	String	-	Cluster UUID
`cluster.name`	String	-	Cluster name
`cluster.k8sVersion`	String	-	Kubernetes version
`cluster.regionCode`	String	-	Region code
`cluster.kuberNetworkPlugin`	String	-	CNI plugin code
`cluster.vpcNo`	Integer	-	VPC ID
`cluster.subnetNoList`	Array	-	Subnet ID list
`cluster.subnetLbNo`	Integer	-	@deprecated Load Balancer-only subnet ID
`cluster.lbPrivateSubnetNo`	Integer	-	Load balancer private subnet ID
`cluster.lbPrivateSubnetName`	String	-	Load balancer private subnet name
`cluster.lbPublicSubnetNo`	Integer	-	Load balancer private subnet number
`cluster.lbPublicSubnetName`	String	-	Load balancer private subnet name
`cluster.vpcName`	String	-	VPC name
`cluster.subnetName`	String	-	@deprecated Subnet name
`cluster.subnetNameList`	Array	-
`cluster.subnetLbName`	String	-	@deprecated Load Balancer-only subnet name
`cluster.loginKeyName`	String	-	Authentication key name
`cluster.zoneCode`	String	-	Zone code
`cluster.zoneNo`	Integer	-	Zone number
`cluster.log`	Array	-	Log list
`cluster.log.audit`	Boolean	-	Set audit log
`cluster.publicNetwork`	Boolean	-	Public Network
`cluster.iamAuth`	Boolean	-
`cluster.isDefaultIamAuth`	Boolean	-
`cluster.returnProtection`	Boolean	-
`cluster.kmsKeyTag`	String	-
`cluster.authType`	String	-	Cluster authentication method
`cluster.nodePool`	Array	-	NodePool list: nodePool

`nodePool`

The following describes nodePool.

Field	Type	Required	Description
`instanceNo`	Integer	-	NodePool instance number
`k8sVersion`	String	-	NodePool Kubernetes version
`name`	String	-	NodePool name
`nodeCount`	Integer	-	Number of nodes
`subnetNoList`	Array	-	NodePool subnet number list
`subnetNameList`	Array	-	@deprecated NodePool subnet name list
`softwareCode`	String	-	Software code
`productCode`	String	-	Product code
`serverSpecCode`	String	-	Server specification code
`storageSize`	Integer	-	Storage size
`status`	String	-	NodePool status
`autoscale`	Array	-	Autoscaling list
`autoscale.enabled`	Boolean	-
`autoscale.min`	Integer	-
`autoscale.max`	Integer	-
`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

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