Cluster Add-onの照会

VPC環境で利用できます。

クラスタにインストールされている Add-onを照会します。

リクエスト

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

メソッド	URI
GET	/vnks/v2/clusters/{uuid}/addons/{addonRef} (韓国リージョン)
GET	/vnks/sgn-v2/clusters/{uuid}/addons/{addonRef} (シンガポールリージョン)
GET	/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リストの照会を参照

リクエスト例

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

curl --location --request GET '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'

レスポンス

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

レスポンス構文

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

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`uuid`	String	-	インストールされている Add-onの UUID
`clusterUuid`	String	-	クラスタの UUID
`addonName`	String	-	Add-onの名前
`version`	String	-	インストールされている Add-onのバージョン
`configurationValues`	String	-	Helm values再定義値 (JSONオブジェクト文字列) 未設定時、`{}`
`displayName`	String	-	Add-onの表示名
`description`	String	-	Add-onの説明
`category`	String	-	Add-onのカテゴリ
`status`	String	-	Add-onの状態
`message`	String	-	状態の詳細メッセージ失敗状態でのみ提供それ以外の場合は、空の値または省略
`k8sVersion`	String	-	クラスタの Kubernetesバージョン
`latestVersion`	String	-	インストール可能な最新バージョン現在のバージョンより新しいバージョンがある場合にのみ提供
`createdAt`	String	-	インストール日
`updatedAt`	String	-	最終更新日時

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

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": "running",
    "message": "",
    "k8sVersion": "1.36.2-nks.1",
    "latestVersion": "",
    "createdAt": "2025-06-05T10:15:30.000Z",
    "updatedAt": "2025-06-05T10:20:12.000Z"
}

Documentation Index