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

リクエストヘッダ

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

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

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

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

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

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

フィールド タイプ 必須の有無 説明
k8sVersion String Required Kubernetesバージョン

リクエスト例

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

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/addon-configs/nks-csi/versions/v1.1.0?k8sVersion=1.27.9-nks.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",
  "version": "string",
  "deprecated": "boolean",
  "requiresWorkerNodes": "boolean",
  "chartRefPattern": "string",
  "configurationSchema": "object"
}

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
name String - Add-onの名前
version String - Add-onのバージョン
deprecated Boolean - サポート終了状況
  • true | false
    • true: サポート終了 (新規インストール不可)
    • false: インストール可能
requiresWorkerNodes Boolean - インストール時、ワーカーノードは必要か
chartRefPattern String - Helmチャートの参照パターン
configurationSchema Object - configurationValuesの作成に使用する JSONスキーマ

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

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

レスポンス例

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

{
    "name": "nks-csi",
    "version": "v1.1.0",
    "deprecated": false,
    "requiresWorkerNodes": true,
    "chartRefPattern": "oci://nks.registry.ntruss.com/addons/nks-csi:{version}",
    "configurationSchema": {
        "type": "object",
        "properties": {
            "replicaCount": {
                "type": "integer",
                "default": 1
            }
        }
    }
}