Cluster Add-onリストの照会

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`uuid`	String	Required	クラスタの UUID Clusterリストの照会を参照

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

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

フィールド	タイプ	必須の有無	説明
`status`	String	Optional	Add-onの状態
`page`	Integer	Optional	ページ番号
`size`	Integer	Optional	ページごとの項目数

リクエスト例

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

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

レスポンス

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

レスポンス構文

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

{
  "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",
  "page": "integer",
  "size": "integer"
}

レスポンスボディ

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

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

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

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

Documentation Index