Available in VPC
Get the cluster list.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | /vnks/v2/clusters (Korea Region) |
| GET | /vnks/sgn-v2/clusters (Singapore Region) |
| GET | /vnks/jpn-v2/clusters (Japan Region) |
Request headers
For information about the headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service request headers.
Request example
The request example is as follows:
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'
Response
This section 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",
"authType": "String",
"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"
}
}
]
}
]
}
Response body
The response syntax is as follows:
| Field | Type | Required | Description |
|---|---|---|---|
clusters |
Array | - | Cluster list: clusters |
clusters
The following describes clusters.
| Field | Type | Required | Description |
|---|---|---|---|
cpuCount |
Integer | - | Number of CPUs |
memorySize |
Integer | - | Total memory capacity |
status |
String | - | Cluster status |
nodeCount |
Integer | - | Total number of nodes registered |
nodeMaxCount |
Integer | - | Maximum number of available nodes |
clusterType |
String | - | Cluster type |
hypervisorCode |
String | - | Hypervisor code |
instanceNo |
Integer | - | Instance number |
id |
Integer | - | Cluster ID |
acgName |
String | - | ACG name |
acgNo |
Integer | - | ACG number |
capacity |
String | - | Cluster capacity |
createdAt |
String | - | Cluster creation date and time |
updatedAt |
String | - | Last update date and time |
endpoint |
String | - | Control Plane API address |
uuid |
String | - | Cluster UUID |
name |
String | - | Cluster name |
k8sVersion |
String | - | Kubernetes version |
regionCode |
String | - | Region code |
kuberNetworkPlugin |
String | - | CNI plugin code |
vpcNo |
Integer | - | VPC ID |
subnetNoList |
Array | - | Subnet ID list |
subnetLbNo |
Integer | - | @deprecated Load Balancer-only subnet ID |
lbPrivateSubnetNo |
Integer | - | Load balancer private subnet ID |
lbPrivateSubnetName |
String | - | Load balancer private subnet name |
lbPublicSubnetNo |
Integer | - | Load balancer public subnet number |
lbPublicSubnetName |
String | - | Load balancer public subnet name |
vpcName |
String | - | VPC name |
subnetName |
String | - | @deprecated Subnet name |
subnetNameList |
Array | - | |
subnetLbName |
String | - | @deprecated Load Balancer-only subnet name |
loginKeyName |
String | - | Authentication key name |
zoneCode |
String | - | Zone code |
zoneNo |
Integer | - | Zone number |
log |
Array | - | Log list |
log.audit |
Boolean | - | Set audit log |
publicNetwork |
Boolean | - | Public Network |
iamAuth |
Boolean | - | |
isDefaultIamAuth |
Boolean | - | |
returnProtection |
Boolean | - | |
kmsKeyTag |
String | - | |
authType |
String | - | Cluster authentication method |
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:
{
"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,
"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
}
}
]
}
]
}