Ncloud Kubernetes Service

Prev Next

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

VPC 환경의 Ncloud Kubernetes Service 서버 인스턴스(VM) 목록을 조회합니다.

요청

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

메서드 URI
GET /api/{regionCode}-v1/vpc/servers/kubernetes

요청 헤더

Cloud Log Analytics API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Log Analytics 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

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

필드 타입 필수 여부 설명
regionCode String Required 리전 코드
  • kr | krs
    • kr: 수도권
    • krs: 남부권

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
pageNo Integer Optional 페이지 번호
  • 1~100 (기본값: 1)
pageSize Integer Optional 페이지당 항목 수
  • 20~100 (기본값: 20)

요청 예시

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

curl --location --request GET 'https://cloudloganalytics.apigw.gov-ntruss.com/api/{regionCode}-v1/vpc/servers/kubernetes' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code Integer - 응답 상태 코드
message String - 응답 상태 메시지
result Object - 응답 결과
result.pageSize Integer - 페이지당 항목 수
result.currentPage Integer - 현재 페이지 번호
result.totalPage Integer - 전체 페이지 수
result.totalCount Integer - 전체 항목 수
result.isPaged Boolean - 페이징 여부
  • true | false
    • true: 페이징
    • false: 페이징 안 함
result.clusters Array - 서버 목록
  • 서버 정보
참고

Server 정보 관련 필드(clusters)에 대한 설명은 Ncloud Kubernetes Service API 가이드와 Ncloud Kubernetes Service 사용 가이드를 참조해 주십시오.

응답 상태 코드

Cloud Log Analytics API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Log Analytics 응답 상태 코드를 참조해 주십시오.

응답 예시

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

{
    "code": 0,
    "message": "요청이 정상적으로 처리되었습니다",
    "result": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPage": 1,
        "totalCount": 1,
        "isPaged": true,
        "clusters": [
            {
                "name": "nks-test",
                "k8sVersion": "1.29.9",
                "vpcNm": "test",
                "subnetNm": "testsubnet",
                "collectionStatusNameValue": "미설정",
                "collectionStatusNameColor": "grey",
                "requestParam": {
                    "vpcNm": "test | ***.***.***.***/**",
                    "subnetNm": "testsubnet | KR-1 | ***.***.***.***/** | Private",
                    "logEnable": "N"
                }
            }
        ]
    }
}