MENU
      Cluster 목록 조회
        • PDF

        Cluster 목록 조회

        • PDF

        기사 요약

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

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

        요청

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

        메서드URI
        GET/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'
        Curl

        응답

        응답 형식을 설명합니다.

        응답 구문

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

        {
            "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",
                    "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"
                            }
                        }
                    ]
                }
            ]
        }
        JSON

        응답 바디

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

        필드타입필수 여부설명
        clusters[]Array-클러스터 목록
        clusters[].cpuCountInteger-CPU 개수
        clusters[].memorySizeInteger-총 메모리 용량
        clusters[].statusString-클러스터 상태
        clusters[].nodeCountInteger-등록된 노드의 총 개수
        clusters[].nodeMaxCountInteger-사용할 수 있는 노드의 최대 개수
        clusters[].clusterTypeString-클러스터 유형
        clusters[].hypervisorCodeString-하이퍼바이저 코드
        clusters[].instanceNoInteger-인스턴스 번호
        clusters[].idInteger-클러스터 ID
        clusters[].acgNameString-ACG 이름
        clusters[].acgNoInteger-ACG 번호
        clusters[].capacityString-클러스터 용량
        clusters[].createdAtString-클러스터 생성 일시
        clusters[].updatedAtString-최근 업데이트 일시
        clusters[].endpointString-Control Plane API 주소
        clusters[].uuidString-클러스터 UUID
        clusters[].nameString-클러스터 이름
        clusters[].k8sVersionString-쿠버네티스 버전
        clusters[].regionCodeString-리전 코드
        clusters[].kuberNetworkPluginString-CNI 플러그인 코드
        clusters[].vpcNoInteger-VPC ID
        clusters[].subnetNoList[]Array-서브넷 ID 목록
        clusters[].subnetLbNoInteger-@deprecated Load Balancer 전용 서브넷 ID
        clusters[].lbPivateSubnetNoInteger-로드 밸런서 사설 Subnet ID
        clusters[].lbPivateSubnetNameString-로드 밸런서 사설 Subnet 이름
        clusters[].lbPublicSubnetNoInteger-로드 밸런서 사설 Subnet 번호
        clusters[].lbPublicSubnetNameString-로드 밸런서 사설 Subnet 이름
        clusters[].vpcNameString-VPC 이름
        clusters[].subnetNameString-@deprecated Subnet 이름
        clusters[].subentNameList[]Array-
        clusters[].subnetLbNameString-@deprecated Load Balancer 전용 Subnet 이름
        clusters[].loginKeyNameString-인증키 이름
        clusters[].zoneCodeString-존 코드
        clusters[].zoneNoInteger-존 번호
        clusters[].logArray-로그 목록
        clusters[].log.auditBoolean-Audit Log 설정
        clusters[].publicNetworkBoolean-Public Network
        clusters[].iamAuthBoolean-
        clusters[].isDefaultIamAuthBoolean-
        clusters[].returnProtectionBoolean-
        clusters[].kmsKeyTagString-
        clusters[].nodePool[]Array-노드풀 목록
        clusters[].nodePool[].instanceNoInteger-노드풀 인스턴스 번호
        clusters[].nodePool[].k8sVersionString-노드풀 쿠버네티스 버전
        clusters[].nodePool[].nameString-노드풀 이름
        clusters[].nodePool[].nodeCountInteger-노드 개수
        clusters[].nodePool[].subnetNoList[]Array-노드풀 Subnet 번호 목록
        clusters[].nodePool[].subnetNameList[]Array-@deprecated 노드풀 Subnet 이름 목록
        clusters[].nodePool[].softwareCodeString-소프트웨어 코드
        clusters[].nodePool[].productCodeString-상품 코드
        clusters[].nodePool[].serverSpecCodeString-서버 스펙 코드
        clusters[].nodePool[].storageSizeInteger-스토리지 크기
        clusters[].nodePool[].statusString-노드풀 상태
        clusters[].nodePool[].autoscaleArray-오토 스케일링 목록
        clusters[].nodePool[].autoscale.enabledBoolean-
        clusters[].nodePool[].autoscale.minInteger-
        clusters[].nodePool[].autoscale.maxInteger-
        clusters[].nodePool[].serverRoleIdString-IAM 서버 Role ID

        응답 상태 코드

        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,
                    "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
                            }
                        }
                    ]
                }
            ]
        }
        JSON

        이 문서가 도움이 되었습니까?

        What's Next
        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.