NodePool 조회

Prev Next

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

클러스터 안에 노드를 생성하기 위해 설정한 노드풀의 목록을 조회합니다.

요청

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

메서드 URI
GET /clusters/{uuid}/node-pool

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
uuid String Required 클러스터의 UUID

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
hypervisorCode String Optional 서버의 하이퍼바이저 유형
  • XEN (기본값) | KVM

요청 예시

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

curl --location 'https://nks.apigw.gov-ntruss.com/vnks/v2/clusters/{uuid}/node-pool?hypervisorCode=XEN' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \

응답

응답 형식을 설명합니다.

응답 구문

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

{
    "nodePool": [
        {
            "instanceNo": "integer",
            "k8sVersion": "string",
            "labels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "name": "string",
            "nodeCount": "integer",
            "serverSpecCode": "string",
            "softwareCode": "string",
            "status": "string",
            "subnets": [],
            "taints": [
                {
                    "key": "string",
                    "effect": "string",
                    "value": "string"
                }
            ],
            "storageSize": "integer",
            "productCode": "string",
            "subnetNameList": [],
            "subnetNoList": [],
            "autoscale": {
                "enabled": "boolean"
            }
        },
        {
            "instanceNo": "integer",
            "k8sVersion": "string",
            "labels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "name": "string",
            "nodeCount": "integer",
            "serverSpecCode": "string",
            "softwareCode": "string",
            "status": "string",
            "subnets": [],
            "taints": [
                {
                    "key": "string",
                    "effect": "string",
                    "value": "string"
                }
            ],
            "storageSize": "integer",
            "productCode": "string",
            "subnetNameList": [],
            "subnetNoList": [],
            "autoscale": {
                "enabled": "boolean"
            }
        }
    ]
}

응답 바디

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

필드 타입 필수 여부 설명
nodePool[] Array - 노드풀 목록
nodePool[].instanceNo Integer - 노드풀의 인스턴스 번호
nodePool[].k8sVersion String - 쿠버네티스 버전
nodePool[].labels[] String - 노드풀의 식별을 위한 레이블
nodePool[].labels[].key String - 레이블의 키
nodePool[].labels[].value String - 레이블의 값
nodePool[].name String - 노드풀의 이름
nodepool.nodeCount String - 노드 개수
  • 1~250
nodePool[].serverSpecCode String - 노드풀 서버의 스펙 코드
  • 서버의 하이퍼바이저 유형이 KVM일 경우 표시
nodePool[].softwareCode String - 서버 이미지 정보
nodePool[].status String - 노드풀의 현재 상태
nodePool[].subnets Array - 노드풀에 소속된 서브넷 목록
nodePool[].taints[] Array - 스케줄러의 노드 관리를 위해 설정된 Taint 목록
nodePool[].taints[].key String - Taint의 키
nodePool[].taints[].effect String - 스케줄러 관리 방식
  • NoSchedule | PreferNoSchedule | NoExecute
nodePool[].taints[].value String - Taint의 값
nodePool[].storageSize Integer - 노드풀 서버의 스토리지 크기
nodePool[].productCode String - 노드풀 서버의 스펙 코드
  • 서버의 하이퍼바이저 유형이 ZEN일 경우 표시
nodePool[].subnetNameList[] Array - 서브넷의 이름 목록
nodePool[].subnetNoList[] Array - 서브넷의 번호 목록
nodePool[].autoscale Array - 오토스케일 정보
nodePool[].autoscale.enabled Boolean - 오토스케일 가능 여부
  • true | false
nodePool[].autoscale.min Integer - 최소 노드 수
nodePool[].autoscale.max Integer - 최대 노드 수
nodePool[].serverRoleId String - IAM 서버 Role ID

응답 상태 코드

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

응답 예시

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

{
    "nodePool": [
        {
            "instanceNo": 00000000,
            "k8sVersion": "1.27.9-nks.2",
            "labels": [
                {
                    "key": "key",
                    "value": "value"
                }
            ],
            "name": "name",
            "serverSpecCode": "s2-g3",
            "softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR22.WRKND.G003",
            "status": "RUN",
            "subnets": [],
            "taints": [
                {
                    "key": "key",
                    "effect": "NoExecute",
                    "value": "value"
                }
            ],
            "storageSize": 100,
            "productCode": "SVR.VSVR.STAND.C002.M008.G003",
            "subnetNameList": [],
            "subnetNoList": [],
            "serverRoleId": "***1fdc0-eb90-11ec-a2d9-246e966eb***",
            "autoscale": {
                "enabled": false
            }
        },
        {
            "instanceNo": 00000000,
            "k8sVersion": "1.27.9-nks.2",
            "labels": [
                {
                    "key": "key",
                    "value": "value"
                }
            ],
            "name": "name",
            "nodeCount": 3,
            "serverSpecCode": "s2-g3",
            "softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR22.WRKND.G003",
            "status": "RUN",
            "subnets": [],
            "taints": [
                {
                    "key": "key",
                    "effect": "NoExecute",
                    "value": "value"
                }
            ],
            "storageSize": 100,
            "productCode": "SVR.VSVR.STAND.C002.M008.G003",
            "subnetNameList": [],
            "subnetNoList": [],
            "autoscale": {
                "enabled": true,
                "min": 1,
                "max": 3
            }
        }
    ]
}