--- title: "ダッシュボードの照会" slug: "analytics-vpcsearchengine-dashboard-getdashboardinfo" tags: ["Search Engine Service"] updated: 2026-09-17T09:57:29Z published: 2026-09-17T09:57:29Z canonical: "api.ncloud-docs.com/analytics-vpcsearchengine-dashboard-getdashboardinfo" --- > ## 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/dashboard/getDashboardInformation/{serviceGroupInstanceNo} (韓国リージョン) | | GET | /api/sgn-v2/dashboard/getDashboardInformation/{serviceGroupInstanceNo} (シンガポールリージョン) | | GET | /api/jpn-v2/dashboard/getDashboardInformation/{serviceGroupInstanceNo} (日本リージョン) | ### リクエストヘッダ Search Engine Service APIで共通して使用されるヘッダの詳細は、[Search Engine Serviceのリクエストヘッダ](/docs/ja/analytics-vpcsearchengine#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストパスパラメータ リクエストパスパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `serviceGroupInstanceNo` | Integer | Required | クラスタインスタンス番号 - [クラスタリストの照会](/docs/ja/analytics-vpcsearchengine-cluster-getclusterinfolist)を参照 | ### リクエストクエリパラメータ リクエストクエリパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `pageNo` | Integer | Optional | ページ番号 - 1~N (デフォルト: 1) | | `pageSize` | Integer | Optional | ページの出力数 - 1~N (デフォルト: 10) | ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/dashboard/getDashboardInformation/1037****' \ --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.clusterIndicesStatus` | Object | - | Index状態情報 | | `result.clusterIndicesStatus.pageSize` | Integer | - | ページ表示数 | | `result.clusterIndicesStatus.currentPage` | Integer | - | 現在のページ番号 | | `result.clusterIndicesStatus.totalPage` | Integer | - | ページの総数 | | `result.clusterIndicesStatus.totalCount` | Integer | - | レスポンス結果数 | | `result.clusterIndicesStatus.isPaged` | Boolean | - | ページングするかどうか - `true` \| `false` - `true`: ページング - `false`: ページングしない | | `result.clusterIndicesStatus.indiceInfoList` | Array | - | Indexリスト: [indiceInfoList](/docs/ja/analytics-vpcsearchengine-dashboard-getdashboardinfo#indiceInfoList) | | `result.clusterStatus` | Object | - | クラスタの状態情報 | | `result.clusterStatus.status` | String | - | クラスタ状態のレベル - `green` \| `yellow` \| `red` \| `blue` - `green`: 運用中 - `yellow`: 警告 - `red`: エラー - `blue`: 不明 | | `result.clusterStatus.indicesCount` | String | - | クラスタの Index数(ノード数) | | `result.clusterStatus.shardCount` | String | - | クラスタの Shard数 | | `result.clusterStatus.docsCount` | String | - | クラスタの Document数 | | `result.clusterStatus.storeSizeInUsed` | String | - | ディスクの総使用量 | | `result.clusterStatus.segmentsCount` | String | - | クラスタの Segment数 | | `requestId` | String | - | リクエスト ID - UUID形式 | #### `indiceInfoList` `indiceInfoList`の説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `health` | String | - | Index状態のレベル - `green` \| `yellow` \| `red` \| `blue` - `green`: 運用中 - `yellow`: 警告 - `red`: エラー - `blue`: 不明 | | `status` | String | - | Index状態 | | `indexName` | String | - | Index名 | | `uuid` | String | - | Index UUID | | `primaryCount` | String | - | Primary Shard数 | | `replicaCount` | String | - | Replica Shard数 | | `docsCount` | String | - | Document数 | | `docsDeleted` | String | - | 削除された Document数 | | `storeSize` | 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": { "clusterIndicesStatus": { "pageSize": 20, "currentPage": 1, "totalPage": 1, "totalCount": 4, "isPaged": true, "indiceInfoList": [ { "health": "green", "status": "open", "indexName": ".plugins-ml-config", "uuid": "sGTZgi9***************", "primaryCount": "1", "replicaCount": "2", "docsCount": "1", "docsDeleted": "0", "storeSize": "12.2kb" }, { "health": "green", "status": "open", "indexName": ".opensearch-observability", "uuid": "tP0IVxG***************", "primaryCount": "1", "replicaCount": "2", "docsCount": "0", "docsDeleted": "0", "storeSize": "624b" }, { "health": "green", "status": "open", "indexName": ".opendistro_security", "uuid": "WiQoV_S***************", "primaryCount": "1", "replicaCount": "2", "docsCount": "10", "docsDeleted": "0", "storeSize": "152.4kb" }, { "health": "green", "status": "open", "indexName": ".kibana_1", "uuid": "Yv5j0mv***************", "primaryCount": "1", "replicaCount": "1", "docsCount": "0", "docsDeleted": "0", "storeSize": "416b" } ] }, "clusterStatus": { "status": "green", "indicesCount": "5", "shardCount": "14", "docsCount": "463", "storeSizeInUsed": "501.9kb", "segmentsCount": "13" } }, "requestId": "826a7452-****-****-****-ae0abcdf6b7b" } ```