Cluster Add-onの変更

VPC環境で利用できます。

クラスタにインストールされている Add-onのバージョンまたは設定を変更します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
PATCH	/vnks/v2/clusters/{uuid}/addons/{addonRef} (韓国リージョン)
PATCH	/vnks/sgn-v2/clusters/{uuid}/addons/{addonRef} (シンガポールリージョン)
PATCH	/vnks/jpn-v2/clusters/{uuid}/addons/{addonRef} (日本リージョン)

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`uuid`	String	Required	クラスタの UUID Clusterリストの照会を参照
`addonRef`	String	Required	Add-onの名前またはインストールされている Add-onの UUID Cluster Add-onリストの照会を参照

リクエスト構文

リクエスト構文は次の通りです。

{
  "version": "string",
  "configurationValues": "string",
  "resolveConflicts": "string"
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`version`	String	Conditional	変更後の Add-onのバージョン `configurationValues`と`resolveConflicts`を入力しなかった場合、必ず入力 Add-onの照会の`versions[]`を参照未入力時、現行バージョンを保持
`configurationValues`	String	Conditional	Helm values再定義値 (JSONオブジェクト文字列) `version`と`resolveConflicts`を入力しなかった場合、 Add-onバージョンの照会の`configurationSchema`を参照未入力時、現在の値を保持空の文字列(`""`)を入力した場合、`{}`でリセット
`resolveConflicts`	String	Conditional	クラスタ内で直接変更されたフィールドの処理方法 `version`と`configurationValues`を入力しなかった場合、 `Overwrite`(デフォルト) \| `Preserve` `Overwrite`: Add-on設定値で上書き `Preserve`: 直接変更した値を保持

リクエスト例

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

curl --location --request PATCH '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' \
--data '{
  "version": "1.0.0"
}'

レスポンス

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

レスポンス構文

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

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

レスポンスボディ

変更リクエストが受付された Add-onの情報を返します。変更の完了状況はCluster Add-onの照会で確認できます。レスポンスボディの各フィールドの詳細は、Cluster Add-on照会のレスポンスボディをご参照ください。

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

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": "update_in_progress",
    "message": "",
    "k8sVersion": "1.36.2-nks.1",
    "latestVersion": "",
    "createdAt": "2025-06-05T10:15:30.000Z",
    "updatedAt": "2025-06-10T09:02:44.000Z"
}

Documentation Index