Cluster 조회
    • PDF

    Cluster 조회

    • PDF

    기사 요약

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

    특정 클러스터 정보를 조회합니다.

    요청

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

    메서드URI
    GET/clusters/{uuid}

    요청 헤더

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

    요청 경로 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    uuidStringRequired클러스터의 UUID

    요청 예시

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

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

    응답

    응답 형식을 설명합니다.

    응답 바디

    응답 바디에 대한 설명은 다음과 같습니다.

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

    응답 상태 코드

    Ncloud Kubernetes Service API에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud Kubernetes Service 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

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

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

    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.