VPC環境で利用できます。
特定のクラスタに1つ以上の Add-onをインストールします。
参考
リクエストを検証した後、インストールを開始します。検証に失敗した Add-onがある場合、リクエストされたすべての Add-onはインストールされません。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /vnks/v2/clusters/{uuid}/addons (韓国リージョン) |
| POST | /vnks/sgn-v2/clusters/{uuid}/addons (シンガポールリージョン) |
| POST | /vnks/jpn-v2/clusters/{uuid}/addons (日本リージョン) |
リクエストヘッダ
Ncloud Kubernetes Service APIで共通して使用されるヘッダの詳細は、Ncloud Kubernetes Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
uuid |
String | Required | クラスタの UUID |
リクエスト構文
リクエスト構文は次の通りです。
[
{
"addonName": "string",
"version": "string",
"configurationValues": "string",
"resolveConflicts": "string"
}
]
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
[] |
Array | Required | インストールする Add-onリスト |
[].addonName |
String | Required | インストールする Add-onの名前
|
[].version |
String | Required | インストールする Add-onのバージョン
|
[].configurationValues |
String | Optional | Helm values再定義値 (JSONオブジェクト文字列)
|
[].resolveConflicts |
String | Optional | クラスタ内で直接変更されたフィールドの処理方法
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://nks.apigw.ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****/addons' \
--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 '[
{
"addonName": "nks-csi",
"version": "1.0.0"
},
{
"addonName": "external-dns",
"version": "1.0.0",
"configurationValues": "{\"policy\": \"sync\"}",
"resolveConflicts": "Overwrite"
}
]'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
{
"addons": [
{
"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"
}
],
"totalCount": "integer"
}
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
addons[] |
Array | - | インストールリクエストされた Add-onリスト |
totalCount |
Integer | - | インストールリクエストされた Add-on数 |
addons[]の各フィールドの詳細は、Cluster Add-on照会のレスポンスボディをご参照ください。
レスポンスステータスコード
Ncloud Kubernetes Service APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Kubernetes Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"addons": [
{
"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": "install_in_progress",
"message": "",
"k8sVersion": "1.36.2-nks.1",
"latestVersion": "",
"createdAt": "2025-06-05T10:15:30.000Z",
"updatedAt": "2025-06-05T10:15:30.000Z"
},
{
"uuid": "****c4a2-3d5e-4b7f-8a91-2b3c4d5e****",
"clusterUuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****",
"addonName": "external-dns",
"version": "1.0.0",
"configurationValues": "{\"policy\": \"sync\"}",
"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",
"status": "install_in_progress",
"message": "",
"k8sVersion": "1.36.2-nks.1",
"latestVersion": "",
"createdAt": "2025-06-05T10:15:30.000Z",
"updatedAt": "2025-06-05T10:15:30.000Z"
}
],
"totalCount": 2
}