NodePool 조회

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

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

요청

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

메서드	URI
GET	/vnks/v2/clusters/{uuid}/node-pool (수도권 리전)
GET	/vnks/krs-v2/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"
            },
            "fabricCluster": {
              "poolName": "string",
              "poolNo": "integer"
            }
        },
        {
            "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"
            },
            "fabricCluster": {
              "poolName": "string",
              "poolNo": "integer"
            }
        }
    ]
}

응답 바디

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

필드	타입	필수 여부	설명
`nodePool`	Array	-	노드풀 목록: nodePool

`nodePool`

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

필드	타입	필수 여부	설명
`instanceNo`	Integer	-	노드풀의 인스턴스 번호
`k8sVersion`	String	-	쿠버네티스 버전
`labels`	Array	-	노드풀의 식별을 위한 레이블: labels
`name`	String	-	노드풀의 이름
`nodeCount`	String	-	노드 개수 1~250
`serverSpecCode`	String	-	노드풀 서버의 스펙 코드 서버의 하이퍼바이저 유형이 `KVM`일 경우 표시
`softwareCode`	String	-	서버 이미지 정보
`status`	String	-	노드풀의 현재 상태
`subnets`	Array	-	노드풀에 소속된 서브넷 목록
`taints`	Array	-	스케줄러의 노드 관리를 위해 설정된 Taint 목록: taints
`storageSize`	Integer	-	노드풀 서버의 스토리지 크기
`productCode`	String	-	노드풀 서버의 스펙 코드 서버의 하이퍼바이저 유형이 `ZEN`일 경우 표시
`subnetNameList`	Array	-	서브넷의 이름 목록
`subnetNoList`	Array	-	서브넷의 번호 목록
`autoscale`	Array	-	오토스케일 정보
`autoscale.enabled`	Boolean	-	오토스케일 가능 여부 `true` \| `false`
`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 번호

`labels`

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

필드	타입	필수 여부	설명
`key`	String	-	레이블의 키
`value`	String	-	레이블의 값

`taints`

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

필드	타입	필수 여부	설명
`key`	String	-	Taint의 키
`effect`	String	-	스케줄러 관리 방식 `NoSchedule` \| `PreferNoSchedule` \| `NoExecute`
`value`	String	-	Taint의 값

응답 상태 코드

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
            },
            "fabricCluster": {
              "poolName": "fabric-pool-1",
              "poolNo": 1
            }
        },
        {
            "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
            },
            "fabricCluster": {
              "poolName": "fabric-pool-1",
              "poolNo": 1
            }
        }
    ]
}