--- title: "Clusterリストの照会" slug: "nks-getclusterlist" updated: 2026-09-17T09:57:45Z published: 2026-09-17T09:57:45Z canonical: "api.ncloud-docs.com/nks-getclusterlist" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # Clusterリストの照会 VPC環境で利用できます。 クラスタリストを照会します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET | /vnks/v2/clusters (韓国リージョン) | | GET | /vnks/sgn-v2/clusters (シンガポールリージョン) | | GET | /vnks/jpn-v2/clusters (日本リージョン) | ### リクエストヘッダ Ncloud Kubernetes Service APIで共通して使用されるヘッダの詳細は、[Ncloud Kubernetes Serviceの共通リクエストヘッダ](/docs/ja/compute-vpckubernetesservice#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters' \ --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' ``` ## レスポンス レスポンス形式を説明します。 ### レスポンスボディ レスポンスボディの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `clusters[]` | Array | - | クラスタリスト | | `clusters[].cpuCount` | Integer | - | CPU数 | | `clusters[].memorySize` | Integer | - | メモリの総容量 | | `clusters[].status` | String | - | クラスタの状態 | | `clusters[].nodeCount` | Integer | - | 登録されたノードの総数 | | `clusters[].nodeMaxCount` | Integer | - | 使用可能なノードの最大数 | | `clusters[].clusterType` | String | - | クラスタのタイプ | | `clusters[].hypervisorCode` | String | - | ハイパーバイザコード | | `clusters[].instanceNo` | Integer | - | インスタンス番号 | | `clusters[].id` | Integer | - | クラスタ ID | | `clusters[].acgName` | String | - | ACG名 | | `clusters[].acgNo` | Integer | - | ACG番号 | | `clusters[].capacity` | String | - | クラスタの容量 | | `clusters[].createdAt` | String | - | クラスタの作成日時 | | `clusters[].updatedAt` | String | - | 最終更新日時 | | `clusters[].endpoint` | String | - | Control Plane APIアドレス | | `clusters[].uuid` | String | - | クラスタの UUID | | `clusters[].name` | String | - | クラスタ名 | | `clusters[].k8sVersion` | String | - | Kubernetesバージョン | | `clusters[].regionCode` | String | - | リージョンコード | | `clusters[].kuberNetworkPlugin` | String | - | CNIプラグインコード | | `clusters[].vpcNo` | Integer | - | VPC ID | | `clusters[].subnetNoList[]` | Array | - | サブネット IDリスト | | `clusters[].subnetLbNo` | Integer | - | @deprecated Load Balancer専用のサブネット ID | | `clusters[].lbPrivateSubnetNo` | Integer | - | ロードバランサのプライベート Subnet番号 | | `clusters[].lbPrivateSubnetName` | String | - | ロードバランサのプライベート Subnet名 | | `clusters[].lbPrivateSubnetNoList[]` | Array | - | ロードバランサのプライベート Subnet番号リスト (ゾーンごとに1つ、最初の値が代表サブネット) | | `clusters[].lbPublicSubnetNo` | Integer | - | ロードバランサのパブリック Subnet番号 | | `clusters[].lbPublicSubnetName` | String | - | ロードバランサのパブリック Subnet名 | | `clusters[].lbPublicSubnetNoList[]` | Array | - | ロードバランサのパブリック Subnet番号リスト (ゾーンごとに1つ、最初の値が代表サブネット) | | `clusters[].vpcName` | String | - | VPC名 | | `clusters[].subnetName` | String | - | @deprecated Subnet名 | | `clusters[].subnetNameList[]` | Array | - | Subnet名リスト | | `clusters[].subnetLbName` | String | - | @deprecated Load Balancer専用の Subnet名 | | `clusters[].loginKeyName` | String | - | 認証キー名 | | `clusters[].zoneCode` | String | - | ゾーンコード | | `clusters[].zoneNo` | Integer | - | ゾーン番号 | | `clusters[].log` | Array | - | ログリスト | | `clusters[].log.audit` | Boolean | - | Audit Logを設定 | | `clusters[].publicNetwork` | Boolean | - | Public Network | | `clusters[].iamAuth` | Boolean | - | IAM認証を適用するかどうか | | `clusters[].isDefaultIamAuth` | Boolean | - | デフォルトの IAM認証を適用するかどうか | | `clusters[].isRegional` | Boolean | - | マルチゾーン(Regional)クラスタかどうか | | `clusters[].returnProtection` | Boolean | - | 返却保護設定をするかどうか | | `clusters[].kmsKeyTag` | String | - | Secretの暗号化に使用された KMSキーのタグ | | `clusters[].authType` | String | - | クラスタ認証方式 | | `clusters[].nodePool[]` | Array | - | [ノードプールリスト](/docs/ja/nks-getclusterlist#nodePool) | #### `nodePool` `nodePool`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `nodePool[].instanceNo` | Integer | - | ノードプールインスタンス番号 | | `nodePool[].k8sVersion` | String | - | ノードプール Kubernetesバージョン | | `nodePool[].name` | String | - | ノードプール名 | | `nodePool[].nodeCount` | Integer | - | ノード数 | | `nodePool[].subnetNoList[]` | Array | - | ノードプール Subnet番号リスト | | `nodePool[].subnetNameList[]` | Array | - | @deprecated ノードプール Subnet名リスト | | `nodePool[].softwareCode` | String | - | ソフトウェアコード | | `nodePool[].productCode` | String | - | 商品コード | | `nodePool[].serverSpecCode` | String | - | サーバスペックコード | | `nodePool[].storageSize` | Integer | - | ストレージ容量 | | `nodePool[].status` | String | - | ノードプールの状態 | | `nodePool[].autoscale` | Array | - | オートスケールリスト | | `nodePool[].autoscale.enabled` | Boolean | - | オートスケール設定するかどうか | | `nodePool[].autoscale.min` | Integer | - | 最小ノード数 | | `nodePool[].autoscale.max` | Integer | - | 最大ノード数 | | `nodePool[].serverRoleId` | String | - | IAMサーバの Role ID | | `nodePool[].fabricCluster` | Object | - | Fabric Cluster情報 | | `nodePool[].fabricCluster.poolName` | String | - | Fabric Cluster Pool名 | | `nodePool[].fabricCluster.poolNo` | Integer | - | Fabric Cluster Pool番号 | ### レスポンスステータスコード Ncloud Kubernetes Service APIで共通して使用されるレスポンスステータスコードの詳細は、[Ncloud Kubernetes Serviceのレスポンスステータスコード](/docs/ja/compute-vpckubernetesservice#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 ``` { "clusters": [ { "cpuCount": 2, "memorySize": 8, "status": "RUNNING", "nodeCount": 1, "nodeMaxCount": 1, "clusterType": "AAA.VNKS.STAND.C002.M008.G000", "hypervisorCode": "KVM", "instanceNo": 23320000, "id": 14000, "acgName": "nks-14000-acgname", "acgNo": 160009, "capacity": "vCPU 2EA, Memory 8GB", "createdAt": "2024-03-28T07:30:59.000Z", "updatedAt": "2024-03-28T07:47:53.000Z", "endpoint": "https://****a20e-e0fb-4dc9-af1b-97fd3f8d****.kr.vnks.ntruss.com", "uuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****", "name": "cluster00", "k8sVersion": "1.27.9-nks.2", "regionCode": "KR", "kubeNetworkPlugin": "cilium", "vpcNo": 59000, "subnetNoList": [ 139000 ], "subnetLbNo": 139000, "lbPrivateSubnetNo": 139000, "lbPrivateSubnetName": "k8s-lbsubnet2 | KR-1 | 0.0.0.0/0 | Private", "lbPrivateSubnetNoList": [ 139000 ], "lbPublicSubnetNo": 139000, "lbPublicSubnetName": "k8s-lbsubnet | KR-1 | 0.0.0.0/0 | Public", "lbPublicSubnetNoList": [ 139000 ], "vpcName": "k8s-vpc | 0.0.0.0/0", "subnetName": "k8s-subnet", "subnetNameList": [ "k8s-subnet | KR-1 | 0.0.0.0/0 | Public" ], "subnetLbName": "k8s-lbsubnet2 | KR-1 | 0.0.0.0/0 | Private", "loginKeyName": "a123", "zoneCode": "KR-1", "zoneNo": 2, "log": { "audit": false }, "publicNetwork": true, "iamAuth": true, "isDefaultIamAuth": true, "isRegional": false, "returnProtection": false, "authType": "CONFIG_MAP", "kmsKeyTag": "****83e65495374b9cf590a783f442fd50eb48c54eb56774de1ff62bcda4****", "nodePool": [ { "instanceNo": 23320000, "k8sVersion": "1.27.9", "name": "nodepool", "nodeCount": 1, "subnetNoList": [], "subnetNameList": [], "softwareCode": "SW.AAAA.OS.LNX64.UBNTU.SVR22.WRKND.AAAA", "productCode": "SVR.AAAA.STAND.C002.M008.AAAA", "serverSpecCode": "s2-g3", "storageSize": 100, "status": "RUN", "serverRoleId": "***1fdc0-eb90-11ec-a2d9-246e966eb***", "autoscale": { "enabled": false, "min": 0, "max": 0 } } ] } ] } ```