Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

Cluster Add-on 조회

Prev Next

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

클러스터에 설치된 Add-on을 조회합니다.

요청

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

메서드 URI
GET /vnks/v2/clusters/{uuid}/addons/{addonRef} (한국 리전)
GET /vnks/sgn-v2/clusters/{uuid}/addons/{addonRef} (싱가포르 리전)
GET /vnks/jpn-v2/clusters/{uuid}/addons/{addonRef} (일본 리전)

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
uuid String Required 클러스터의 UUID
addonRef String Required Add-on 이름 또는 설치된 Add-on의 UUID

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 구문

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

{
  "uuid": "string",
  "clusterUuid": "string",
  "addonName": "string",
  "version": "string",
  "configurationValues": "string",
  "displayName": "string",
  "description": "string",
  "category": "string",
  "status": "string",
  "message": "string",
  "k8sVersion": "string",
  "latestVersion": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

응답 바디

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

필드 타입 필수 여부 설명
uuid String - 설치된 Addon의 UUID
clusterUuid String - 클러스터의 UUID
addonName String - Addon 이름
version String - 설치된 Addon 버전
configurationValues String - Helm values 재정의 값 (JSON 객체 문자열)
  • 미설정 시 {}
displayName String - Addon 표시 이름
description String - Addon 설명
category String - Addon 카테고리
status String - Addon 상태
message String - 상태 상세 메시지
  • 실패 상태에서만 제공
  • 그 외 상태에서는 빈 값 또는 생략
k8sVersion String - 클러스터의 쿠버네티스 버전
latestVersion String - 설치 가능한 최신 버전
  • 현재 버전보다 높은 버전이 있을 때만 제공
createdAt String - 설치 일시
updatedAt String - 최근 수정 일시

응답 상태 코드

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

응답 예시

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

{
    "uuid": "****b3f1-2c4d-4a6e-9f80-1a2b3c4d****",
    "clusterUuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****",
    "addonName": "nks-csi",
    "version": "1.0.0",
    "configurationValues": "{}",
    "displayName": "NKS Block Storage CSI",
    "description": "NKS managed CSI driver for ncloud Block Storage. Provides dynamic volume provisioning, attachment, snapshot, and resize.",
    "category": "storage",
    "status": "running",
    "message": "",
    "k8sVersion": "1.36.2-nks.1",
    "latestVersion": "",
    "createdAt": "2025-06-05T10:15:30.000Z",
    "updatedAt": "2025-06-05T10:20:12.000Z"
}