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.

Add-on 목록 조회

Prev Next

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

클러스터에 설치할 수 있는 Add-on 목록을 조회합니다.

요청

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

메서드 URI
GET /vnks/v2/addon-configs (한국 리전)
GET /vnks/sgn-v2/addon-configs (싱가포르 리전)
GET /vnks/jpn-v2/addon-configs (일본 리전)

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
k8sVersion String Required 쿠버네티스 버전
  • major.minor.patch 형식
  • 클러스터 쿠버네티스 버전에서 - 이후 접미사를 제외하고 입력
  • 예시: 클러스터 버전이 1.36.2-nks.1인 경우, 1.36.2
page Integer Optional 페이지 번호
size Integer Optional 페이지당 항목 수

요청 예시

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

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/addon-configs?k8sVersion=1.36.2' \
--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'

응답

응답 형식을 설명합니다.

응답 구문

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

{
  "totalCount": "integer",
  "page": "integer",
  "size": "integer",
  "addonConfigs": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "category": "string",
      "versions": [
        "string"
      ]
    }
  ]
}

응답 바디

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

필드 타입 필수 여부 설명
totalCount Integer - 전체 Add-on 개수
page Integer - 조회할 페이지 번호
size Integer - 페이지당 항목 수
addonConfigs[] Array - Add-on 목록
addonConfigs[].name String - Add-on 이름
addonConfigs[].displayName String - Add-on 표시 이름
addonConfigs[].description String - Add-on 설명
addonConfigs[].category String - Add-on 카테고리
  • storage | network | security | observability
addonConfigs[].versions[] Array - 설치 가능한 버전 목록
  • 지원 종료(deprecated)된 버전 제외

응답 상태 코드

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

응답 예시

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

{
    "totalCount": 4,
    "page": 1,
    "size": 10,
    "addonConfigs": [
        {
            "name": "external-dns",
            "displayName": "External DNS (NAVER Cloud)",
            "description": "external-dns with the NAVER Cloud Global DNS webhook provider. Syncs Kubernetes Service/Ingress hostnames to NAVER Cloud Global DNS records via the out-of-tree webhook provider (sidecar).",
            "category": "network",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-csi",
            "displayName": "NKS Block Storage CSI",
            "description": "NKS managed CSI driver for ncloud Block Storage. Provides dynamic volume provisioning, attachment, snapshot, and resize.",
            "category": "storage",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-gateway-adapter",
            "displayName": "NKS Gateway API Adapter",
            "description": "Gateway API adapter for NKS — maps Gateway/HTTPRoute to NAVER Cloud ALB via GatewayClass ncloud-alb.",
            "category": "network",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-nas-csi",
            "displayName": "NKS NAS (NFS) CSI",
            "description": "NKS managed CSI driver for ncloud NAS (NFS) storage. Provides dynamic NFS-backed volume provisioning, resize, and snapshot.",
            "category": "storage",
            "versions": [
                "1.0.0"
            ]
        }
    ]
}