--- title: "クラスタリストの照会" slug: "analytics-vpcsearchengine-cluster-getclusterinfolist" tags: ["Search Engine Service"] updated: 2026-09-17T09:57:29Z published: 2026-09-17T09:57:29Z canonical: "api.ncloud-docs.com/analytics-vpcsearchengine-cluster-getclusterinfolist" --- > ## 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. # クラスタリストの照会 VPC環境で利用できます。 Search Engineクラスタリストを照会します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET | /api/v2/cluster/getClusterInfoList (韓国リージョン) | | GET | /api/sgn-v2/cluster/getClusterInfoList (シンガポールリージョン) | | GET | /api/jpn-v2/cluster/getClusterInfoList (日本リージョン) | ### リクエストヘッダ Search Engine Service APIで共通して使用されるヘッダの詳細は、[Search Engine Serviceのリクエストヘッダ](/docs/ja/analytics-vpcsearchengine#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストクエリパラメータ リクエストクエリパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `inputText` | String | Optional | 検索キーワード - クラスタ名が完全一致または一部一致する値を絞り込み | | `vpcName` | String | Optional | VPC名 - 完全一致する値のみ絞り込み | | `pageNo` | Integer | Optional | ページ番号 - 1~N (デフォルト: 1) | | `pageSize` | Integer | Optional | ページの出力数 - 1~N (デフォルト: 10) | ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfoList?pageNo=1&pageSize=20&inputText=cluster&vpcName=myvpc' \ --header 'x-ncp-apigw-timestamp: {Timestamp}' \ --header 'x-ncp-iam-access-key: {Access Key}' \ --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' ``` ## レスポンス レスポンス形式を説明します。 ### レスポンスボディ レスポンスボディの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `code` | Integer | - | レスポンスコード | | `message` | String | - | レスポンスメッセージ | | `result` | Object | - | レスポンス結果 | | `result.currentPage` | Integer | - | 現在のページ番号 | | `result.isFirst` | Boolean | - | 最初のページかどうか - `true` \| `false` - `true`: 最初のページ - `false`: 最初のページではない | | `result.isLast` | Boolean | - | 最後のページかどうか - `true` \| `false` - `true`: 最後のページ - `false`: 最後のページではない | | `result.pageSize` | Integer | - | ページ表示数 | | `result.totalCount` | Integer | - | レスポンス結果数 | | `result.totalPage` | Integer | - | ページの総数 | | `result.allowedClusters` | Array | - | クラスタリスト: [allowedClusters](/docs/ja/analytics-vpcsearchengine-cluster-getclusterinfolist#allowedClusters) | | `result.disallowedClusters` | Array | - | 権限のないクラスタリスト: [disallowedClusters](/docs/ja/analytics-vpcsearchengine-cluster-getclusterinfolist#disallowedClusters) - サブアカウントで呼び出す場合、getClusterDetail権限が適用されないクラスタを表示 | | `requestId` | String | - | リクエスト ID - UUID形式 | #### `allowedClusters` `allowedClusters`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `clusterName` | String | - | クラスタ名 | | `dataNodeType` | String | - | データノードタイプ | | `dataNodeProductName` | String | - | データノードのサーバタイプ名 | | `dataNodeCount` | Integer | - | データノード数 | | `clusterStatus` | String | - | クラスタの状態 | | `searchEngineStatus` | String | - | Search Engineの状態 | | `searchEngineVersion` | String | - | Search Engineのバージョン | | `softwareProductName` | String | - | OSのバージョン | | `createDate` | String | - | クラスタの作成日時 | | `managerNodeType` | String | - | マネージャノードタイプ | | `managerNodeCount` | Integer | - | マネージャノード数 | | `dataStorageVolumeSize` | Integer | - | データノードストレージ容量 | | `managerNodeAccessControlGroupSequence` | Integer | - | マネージャノードの ACG ID | | `managerNodeAccessControlGroupName` | String | - | マネージャノードのACG名 | | `dataNodeAccessControlGroupSequence` | Integer | - | データノードの ACG ID | | `dataNodeAccessControlGroupName` | String | - | データノードのACG名 | | `searchEnginePort` | String | - | Search Engineポート情報 | | `searchEngineDashboardPort` | String | - | ダッシュボードポート番号 | | `loginKeyName` | String | - | 認証キー名 | | `serviceGroupInstanceNo` | String | - | クラスタインスタンス番号 | | `searchEngineUserName` | String | - | Search Engineアクセス ID | | `memberNo` | String | - | ユーザーの NAVERクラウドプラットフォーム会員番号 | | `vpcName` | String | - | VPC名 | | `vpcNo` | Integer | - | VPC番号 | | `managerNodeSubnetName` | String | - | マネージャノード Subnet名 | | `managerNodeSubnetNo` | Integer | - | マネージャノードの Subnet番号 | | `dataNodeSubnetName` | String | - | データノードの Subnet名 | | `dataNodeSubnetNo` | Integer | - | データノードの Subnet番号 | | `isPluginInstalled` | Boolean | - | Object Storageプラグイン(S3 repository)はインストールされているかどうか - `true` (デフォルト) \| `false` - `true`: インストール - `false`: インストールされていない | | `isDualManager` | Boolean | - | マネージャノードを冗長化するかどうか - `true` \| `false` - `true`: 冗長化 - `false`: 冗長化しない | | `accessKeyId` | String | - | Object Storageアクセス用 API認証キー - クラスタのスナップショット作成のために Object Storageアクセス用 API 認証キーを設定した場合に表示 - API認証キーの設定方法: [Search Engine Serviceご利用ガイド](https://guide.ncloud-docs.com/docs/ja/ses-snapshot-vpc#api-%EC%9D%B8%EC%A6%9D%ED%82%A4-%EC%84%A4%EC%A0%95)を参照 | | `isMasterOnlyNodeActivated` | Boolean | - | マスターノードを有効化するかどうか - `true` \| `false` - `true`: 有効化 - `false`: 無効化 | | `masterNodeAccessControlGroupSequence` | Integer | - | マスターノードの ACG ID | | `masterNodeAccessControlGroupName` | String | - | マスターノードのACG名 | | `masterNodeSubnetName` | String | - | マスターノードの Subnet名 | | `masterNodeSubnetNo` | Integer | - | マスターノードの Subnet番号 | | `masterNodeType` | String | - | データノードのタイプ | | `masterNodeProductName` | String | - | マスターノードのサーバタイプ名 | | `masterNodeCount` | Integer | - | マスターノード数 | #### `disallowedClusters` `disallowedClusters`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `clusterName` | String | - | クラスタ名 | | `clusterStatus` | String | - | クラスタの状態 | | `searchEngineStatus` | String | - | Search Engineの状態 | | `serviceGroupInstanceNo` | String | - | クラスタインスタンス番号 | ### レスポンスステータスコード Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、[Search Engine Serviceのレスポンスステータスコード](/docs/ja/analytics-vpcsearchengine#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 ``` { "code": 0, "message": "SUCCESS", "result": { "currentPage": 1, "isFirst": true, "isLast": true, "pageSize": 20, "totalCount": 5, "totalPage": 1, "allowedClusters": [ { "clusterName": "cluster000", "dataNodeType": "[STAND] 2vCPU, 8GB Mem", "dataNodeProductName": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB", "dataNodeCount": 3, "clusterStatus": "running", "searchEngineStatus": "green", "searchEngineVersion": "OpenSearch 2.14.0", "softwareProductName": "CentOS 7.8 (64-bit)", "createDate": "2025-03-20 11:31:48", "managerNodeType": "[STAND] 2vCPU, 8GB Mem", "managerNodeCount": 2, "dataStorageVolumeSize": 322122547200, "managerNodeAccessControlGroupSequence": 249484, "managerNodeAccessControlGroupName": "searchengine-m-1pr1dg", "dataNodeAccessControlGroupSequence": 249483, "dataNodeAccessControlGroupName": "searchengine-do-1pr1dg", "searchEnginePort": "9200", "searchEngineDashboardPort": "5601", "loginKeyName": "loginkey01", "serviceGroupInstanceNo": "1037*****", "searchEngineUserName": "userid", "memberNo": "279****", "vpcName": "myvpc", "vpcNo": 9****, "managerNodeSubnetName": "s1-hd-pri | KR-2 | Private", "managerNodeSubnetNo": 20****, "dataNodeSubnetName": "s1-hd-pri | KR-2 | Private", "dataNodeSubnetNo": 20****, "isPluginInstalled": true, "isDualManager": true, "accessKeyId": "******************", "isMasterOnlyNodeActivated": true, "masterNodeAccessControlGroupSequence": 249485, "masterNodeAccessControlGroupName": "searchengine-mo-1pr1dg", "masterNodeSubnetName": "s1-hd-pri | KR-2 | Private", "masterNodeSubnetNo": 20****, "masterNodeType": "[STAND] 2vCPU, 8GB Mem", "masterNodeProductName": "vCPU 2個、メモリ 8GB、[SSD]ディスク 50GB", "masterNodeCount": 3 }, ... ], "disallowedClusters": [ { "clusterName": "cluster007", "clusterStatus": "running", "searchEngineStatus": "green", "serviceGroupInstanceNo": "1037*****" }, ... ] }, "requestId": "ecc71c59-****-****-****-a46b472f04c4" } ```