--- title: "대시보드 조회" slug: "analytics-vpcsearchengine-dashboard-getdashboardinfo" tags: ["Search Engine Service", "Dashboard"] updated: 2026-10-22T10:46:55Z published: 2026-10-22T10:46:55Z canonical: "api-gov.ncloud-docs.com/analytics-vpcsearchengine-dashboard-getdashboardinfo" --- > ## Documentation Index > Fetch the complete documentation index at: https://api-gov.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/krs-v2/dashboard/getDashboardInformation/{serviceGroupInstanceNo} (남부권) | ### 요청 헤더 Search Engine Service API에서 공통으로 사용하는 헤더에 대한 정보는 [Search Engine Service 요청 헤더](/docs/analytics-vpcsearchengine#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오. ### 요청 경로 파라미터 요청 경로 파라미터에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `serviceGroupInstanceNo` | Integer | Required | 클러스터 인스턴스 번호 - [클러스터 목록 조회](/docs/analytics-vpcsearchengine-cluster-getclusterinfolist) 참조 | ### 요청 쿼리 파라미터 요청 쿼리 파라미터에 대한 설명은 다음과 같습니다. | 필드 | 타입 | 필수 여부 | 설명 | | --- | --- | --- | --- | | `pageNo` | Integer | Optional | 페이지 번호 - 1~N (기본값: 1) | | `pageSize` | Integer | Optional | 페이지 출력 수 - 1~N (기본값: 10) | ### 요청 예시 요청 예시는 다음과 같습니다. ``` curl --location --request GET 'https://vpcsearchengine.apigw.gov-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/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 | - | 요청에 대한 아이디 - 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/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" } ```