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/{addonName} (韓国リージョン)
GET /vnks/sgn-v2/addon-configs/{addonName} (シンガポールリージョン)
GET /vnks/jpn-v2/addon-configs/{addonName} (日本リージョン)

リクエストヘッダ

Ncloud Kubernetes Service APIで共通して使用されるヘッダの詳細は、Ncloud Kubernetes Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
addonName String Required Add-onの名前

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
k8sVersion String Required Kubernetesのバージョン
  • major.minor.patch形式
  • クラスタの Kubernetesバージョンの-以降の接尾辞を除いて入力
  • 例: クラスタのバージョンが1.36.2-nks.1の場合、1.36.2

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "category": "string",
  "versions": [
    "string"
  ]
}

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String - Add-onの名前
displayName String - Add-onの表示名
description String - Add-onの説明
category String - Add-onのカテゴリ
versions[] Array - インストール可能なバージョンリスト
  • サポート終了(deprecated)状態のバージョンを除く

レスポンスステータスコード

Ncloud Kubernetes Service APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Kubernetes Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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"
    ]
}