VPC 환경에서 이용 가능합니다.
클러스터 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /vnks/v2/clusters (한국 리전) |
| GET | /vnks/sgn-v2/clusters (싱가포르 리전) |
| GET | /vnks/jpn-v2/clusters (일본 리전) |
요청 헤더
Ncloud Kubernetes Service API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Kubernetes Service 공통 요청 헤더를 참조해 주십시오.
요청 예시
요청 예시는 다음과 같습니다.
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'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
clusters[] |
Array | - | 클러스터 목록 |
clusters[].cpuCount |
Integer | - | CPU 개수 |
clusters[].memorySize |
Integer | - | 총 메모리 용량 |
clusters[].status |
String | - | 클러스터 상태 |
clusters[].nodeCount |
Integer | - | 등록된 노드의 총 개수 |
clusters[].nodeMaxCount |
Integer | - | 사용할 수 있는 노드의 최대 개수 |
clusters[].clusterType |
String | - | 클러스터 유형 |
clusters[].hypervisorCode |
String | - | 하이퍼바이저 코드 |
clusters[].instanceNo |
Integer | - | 인스턴스 번호 |
clusters[].id |
Integer | - | 클러스터 ID |
clusters[].acgName |
String | - | ACG 이름 |
clusters[].acgNo |
Integer | - | ACG 번호 |
clusters[].capacity |
String | - | 클러스터 용량 |
clusters[].createdAt |
String | - | 클러스터 생성 일시 |
clusters[].updatedAt |
String | - | 최근 업데이트 일시 |
clusters[].endpoint |
String | - | Control Plane API 주소 |
clusters[].uuid |
String | - | 클러스터 UUID |
clusters[].name |
String | - | 클러스터 이름 |
clusters[].k8sVersion |
String | - | 쿠버네티스 버전 |
clusters[].regionCode |
String | - | 리전 코드 |
clusters[].kuberNetworkPlugin |
String | - | CNI 플러그인 코드 |
clusters[].vpcNo |
Integer | - | VPC ID |
clusters[].subnetNoList[] |
Array | - | 서브넷 ID 목록 |
clusters[].subnetLbNo |
Integer | - | @deprecated Load Balancer 전용 서브넷 ID |
clusters[].lbPivateSubnetNo |
Integer | - | 로드 밸런서 사설 Subnet ID |
clusters[].lbPivateSubnetName |
String | - | 로드 밸런서 사설 Subnet 이름 |
clusters[].lbPublicSubnetNo |
Integer | - | 로드 밸런서 사설 Subnet 번호 |
clusters[].lbPublicSubnetName |
String | - | 로드 밸런서 사설 Subnet 이름 |
clusters[].vpcName |
String | - | VPC 이름 |
clusters[].subnetName |
String | - | @deprecated Subnet 이름 |
clusters[].subnetNameList[] |
Array | - | Subnet 이름 목록 |
clusters[].subnetLbName |
String | - | @deprecated Load Balancer 전용 Subnet 이름 |
clusters[].loginKeyName |
String | - | 인증키 이름 |
clusters[].zoneCode |
String | - | 존 코드 |
clusters[].zoneNo |
Integer | - | 존 번호 |
clusters[].log |
Array | - | 로그 목록 |
clusters[].log.audit |
Boolean | - | Audit Log 설정 |
clusters[].publicNetwork |
Boolean | - | Public Network |
clusters[].iamAuth |
Boolean | - | IAM 인증 적용 여부 |
clusters[].isDefaultIamAuth |
Boolean | - | 기본 IAM 인증 적용 대상 여부 |
clusters[].isRegional |
Boolean | - | 멀티존(Regional) 클러스터 여부 |
clusters[].returnProtection |
Boolean | - | 반환 보호 설정 여부 |
clusters[].kmsKeyTag |
String | - | Secret 암호화에 사용된 KMS 키 태그 |
clusters[].authType |
String | - | 클러스터 인증 방식 |
clusters[].nodePool[] |
Array | - | 노드풀 목록 |
nodePool
nodePool에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
nodePool[].instanceNo |
Integer | - | 노드풀 인스턴스 번호 |
nodePool[].k8sVersion |
String | - | 노드풀 쿠버네티스 버전 |
nodePool[].name |
String | - | 노드풀 이름 |
nodePool[].nodeCount |
Integer | - | 노드 개수 |
nodePool[].subnetNoList[] |
Array | - | 노드풀 Subnet 번호 목록 |
nodePool[].subnetNameList[] |
Array | - | @deprecated 노드풀 Subnet 이름 목록 |
nodePool[].softwareCode |
String | - | 소프트웨어 코드 |
nodePool[].productCode |
String | - | 상품 코드 |
nodePool[].serverSpecCode |
String | - | 서버 스펙 코드 |
nodePool[].storageSize |
Integer | - | 스토리지 크기 |
nodePool[].status |
String | - | 노드풀 상태 |
nodePool[].autoscale |
Array | - | 오토 스케일링 목록 |
nodePool[].autoscale.enabled |
Boolean | - | 오토스케일 설정 여부 |
nodePool[].autoscale.min |
Integer | - | 최소 노드 수 |
nodePool[].autoscale.max |
Integer | - | 최대 노드 수 |
nodePool[].serverRoleId |
String | - | IAM 서버 Role ID |
nodePool[].fabricCluster |
Object | - | Fabric Cluster 정보 |
nodePool[].fabricCluster.poolName |
String | - | Fabric Cluster Pool 이름 |
nodePool[].fabricCluster.poolNo |
Integer | - | Fabric Cluster Pool 번호 |
응답 상태 코드
Ncloud Kubernetes Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Kubernetes Service 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"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,
"isRegional": false,
"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
}
}
]
}
]
}