Add-onリストの照会

VPC環境で利用できます。

クラスタにインストール可能な Add-onリストを照会します。

リクエスト

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

メソッド	URI
GET	/vnks/v2/addon-configs (韓国リージョン)
GET	/vnks/sgn-v2/addon-configs (シンガポールリージョン)
GET	/vnks/jpn-v2/addon-configs (日本リージョン)

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`k8sVersion`	String	Required	Kubernetesのバージョン `major.minor.patch`形式クラスタの Kubernetesバージョンの`-`以降の接尾辞を除いて入力例: クラスタのバージョンが`1.36.2-nks.1`の場合、`1.36.2`
`page`	Integer	Optional	ページ番号
`size`	Integer	Optional	ページごとの項目数

リクエスト例

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

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/addon-configs?k8sVersion=1.36.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'

レスポンス

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

レスポンス構文

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

{
  "totalCount": "integer",
  "page": "integer",
  "size": "integer",
  "addonConfigs": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "category": "string",
      "versions": [
        "string"
      ]
    }
  ]
}

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`totalCount`	Integer	-	Add-onの総数
`page`	Integer	-	照会するページ番号
`size`	Integer	-	ページごとの項目数
`addonConfigs[]`	Array	-	Add-onリスト
`addonConfigs[].name`	String	-	Add-onの名前
`addonConfigs[].displayName`	String	-	Add-onの表示名
`addonConfigs[].description`	String	-	Add-onの説明
`addonConfigs[].category`	String	-	Add-onのカテゴリ `storage` \| `network` \| `security` \| `observability`
`addonConfigs[].versions[]`	Array	-	インストール可能なバージョンリストサポート終了(deprecated)状態のバージョンを除く

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

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

レスポンス例

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

{
    "totalCount": 4,
    "page": 1,
    "size": 10,
    "addonConfigs": [
        {
            "name": "external-dns",
            "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",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-csi",
            "displayName": "NKS Block Storage CSI",
            "description": "NKS managed CSI driver for ncloud Block Storage. Provides dynamic volume provisioning, attachment, snapshot, and resize.",
            "category": "storage",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-gateway-adapter",
            "displayName": "NKS Gateway API Adapter",
            "description": "Gateway API adapter for NKS — maps Gateway/HTTPRoute to NAVER Cloud ALB via GatewayClass ncloud-alb.",
            "category": "network",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-nas-csi",
            "displayName": "NKS NAS (NFS) CSI",
            "description": "NKS managed CSI driver for ncloud NAS (NFS) storage. Provides dynamic NFS-backed volume provisioning, resize, and snapshot.",
            "category": "storage",
            "versions": [
                "1.0.0"
            ]
        }
    ]
}

Documentation Index