WorkerNode 조회

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

클러스터 내 등록된 WorkerNode 목록을 조회합니다.

요청

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

메서드	URI
GET	/clusters/{uuid}/nodes

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`uuid`	String	Required	클러스터의 UUID 클러스터 목록 조회를 통해 확인

요청 예시

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

curl --location --request GET 'https://nks.apigw.gov-ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****/nodes' \
--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}'

응답

응답 형식을 설명합니다.

응답 구문

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

{
    "nodes": [
        {
            "id": "Integer",
            "name": "String",
            "serverName": "String",
            "serverSpec": "String",
            "privateIp": "String",
            "publicIp": "String",
            "returnProtectionYn": "String",
            "status": "String",
            "statusCode": "String",
            "statusColor": "String",
            "statusName": "String",
            "serverImageName": "String",
            "cpuCount": "Integer",
            "memorySize": "Integer",
            "softwareCode": "String",
            "productCode": "String",
            "specCode": "String",
            "loginKeyName": "String",
            "k8sStatus": "String",
            "dockerVersion": "String",
            "kernelVersion": "String",
            "nodePoolName": "String",
            "nodePoolId": "Integer",
            "providerID": "String"
        }
    ]
}

응답 바디

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

필드	타입	필수 여부	설명
`nodes[]`	Array	-	WorkerNode 목록
`nodes[].id`	Integer	-	WorkerNode ID
`nodes[].name`	String	-	WorkerNode 이름
`nodes[].serverName`	String	-	서버 이름
`nodes[].serverSpec`	String	-	서버 스팩
`nodes[].privateIp`	String	-	비공인 IP
`nodes[].publicIp`	String	-	공인 IP
`nodes[].returnProtectionYn`	String	-	반납 보호 설정 여부
`nodes[].status`	String	-	현재 상태
`nodes[].statusCode`	String	-	상태 코드
`nodes[].statusColor`	String	-	상태 색깔
`nodes[].statusName`	String	-	상태 이름
`nodes[].serverImageName`	String	-	서버 이미지 이름
`nodes[].cpuCount`	Integer	-	CPU 수
`nodes[].memorySize`	Integer	-	총 메모리 용량
`nodes[].softwareCode`	String	-	서버 이미지 코드
`nodes[].productCode`	String	-	상품 코드
`nodes[].specCode`	String	-	@deprecated 스펙 코드
`nodes[].loginKeyName`	String	-	인증키 이름
`nodes[].k8sStatus`	String	-	쿠버네티스 상태
`nodes[].dockerVersion`	String	-	도커 버전
`nodes[].kernelVersion`	String	-	커널 버전
`nodes[].nodePoolName`	String	-	노드풀 이름
`nodes[].nodePoolId`	Integer	-	노드풀 ID
`nodes[].providerId`	String	-	제공자 ID

응답 상태 코드

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

응답 예시

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

{
    "nodes": [
        {
            "id": 23430000,
            "name": "nodepool01-w-4mnv",
            "serverName": "nodepool01-w-4mnv",
            "serverSpec": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
            "privateIp": "10.0.0.0",
            "publicIp": "223.0.0.0",
            "returnProtectionYn": "Y",
            "status": "RUN",
            "statusCode": "RUN",
            "statusColor": "green",
            "statusName": "Running",
            "serverImageName": "Ubuntu Server 20.04 (64-bit)",
            "cpuCount": 2,
            "memorySize": 8589934592,
            "softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.WRKND.0000",
            "productCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.0000",
            "specCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.0000",
            "loginKeyName": "a123",
            "k8sStatus": "Ready",
            "dockerVersion": "containerd://1.7.12",
            "kernelVersion": "5.4.0-99-generic",
            "nodePoolName": "nodepool01",
            "nodePoolId": 23430000,
            "providerID": "navercloudplatform://23430000"
        }
    ]
}