Cluster 목록 조회

VPC 환경에서 이용 가능합니다.

클러스터 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/clusters
GET	/vnks/v2/clusters (수도권 리전)
GET	/vnks/krs-v2/clusters (남부권 리전)

요청 헤더

Ncloud Kubernetes Service API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Kubernetes Service 요청 헤더를 참조해 주십시오.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://nks.apigw.gov-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": [
        {
            "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"
                    }
                }
            ]
        }
    ]
}

응답 바디

응답 구문 다음과 같습니다.

필드	타입	필수 여부	설명
`clusters`	Array	-	클러스터 목록: clusters

`clusters`

clusters에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`cpuCount`	Integer	-	CPU 개수
`memorySize`	Integer	-	총 메모리 용량
`status`	String	-	클러스터 상태
`nodeCount`	Integer	-	등록된 노드의 총 개수
`nodeMaxCount`	Integer	-	사용할 수 있는 노드의 최대 개수
`clusterType`	String	-	클러스터 유형
`hypervisorCode`	String	-	하이퍼바이저 코드
`instanceNo`	Integer	-	인스턴스 번호
`id`	Integer	-	클러스터 ID
`acgName`	String	-	ACG 이름
`acgNo`	Integer	-	ACG 번호
`capacity`	String	-	클러스터 용량
`createdAt`	String	-	클러스터 생성 일시
`updatedAt`	String	-	최근 업데이트 일시
`endpoint`	String	-	Control Plane API 주소
`uuid`	String	-	클러스터 UUID
`name`	String	-	클러스터 이름
`k8sVersion`	String	-	쿠버네티스 버전
`regionCode`	String	-	리전 코드
`kuberNetworkPlugin`	String	-	CNI 플러그인 코드
`vpcNo`	Integer	-	VPC ID
`subnetNoList`	Array	-	서브넷 ID 목록
`subnetLbNo`	Integer	-	@deprecated Load Balancer 전용 서브넷 ID
`lbPrivateSubnetNo`	Integer	-	로드 밸런서 사설 Subnet ID
`lbPrivateSubnetName`	String	-	로드 밸런서 사설 Subnet 이름
`lbPublicSubnetNo`	Integer	-	로드 밸런서 사설 Subnet 번호
`lbPublicSubnetName`	String	-	로드 밸런서 사설 Subnet 이름
`vpcName`	String	-	VPC 이름
`subnetName`	String	-	@deprecated Subnet 이름
`subentNameList`	Array	-
`subnetLbName`	String	-	@deprecated Load Balancer 전용 Subnet 이름
`loginKeyName`	String	-	인증키 이름
`zoneCode`	String	-	존 코드
`zoneNo`	Integer	-	존 번호
`log`	Array	-	로그 목록
`log.audit`	Boolean	-	Audit Log 설정
`publicNetwork`	Boolean	-	Public Network
`iamAuth`	Boolean	-
`isDefaultIamAuth`	Boolean	-
`returnProtection`	Boolean	-
`kmsKeyTag`	String	-
`authType`	String	-	클러스터 인증 방식
`nodePool`	Array	-	노드풀 목록: nodePool

`nodePool`

nodePool에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`instanceNo`	Integer	-	노드풀 인스턴스 번호
`k8sVersion`	String	-	노드풀 쿠버네티스 버전
`name`	String	-	노드풀 이름
`nodeCount`	Integer	-	노드 개수
`subnetNoList`	Array	-	노드풀 Subnet 번호 목록
`subnetNameList`	Array	-	@deprecated 노드풀 Subnet 이름 목록
`softwareCode`	String	-	소프트웨어 코드
`productCode`	String	-	상품 코드
`serverSpecCode`	String	-	서버 스펙 코드
`storageSize`	Integer	-	스토리지 크기
`status`	String	-	노드풀 상태
`autoscale`	Array	-	오토 스케일링 목록
`autoscale.enabled`	Boolean	-
`autoscale.min`	Integer	-
`autoscale.max`	Integer	-
`serverRoleId`	String	-	IAM 서버 Role ID
`fabricCluster`	Object	-	Fabric Cluster 정보
`fabricCluster.poolName`	String	-	Fabric Cluster Pool 이름
`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,
            "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
                    }
                }
            ]
        }
    ]
}