---
title: "대시보드 조회"
slug: "analytics-vpcsearchengine-dashboard-getdashboardinfo"
tags: ["Search Engine Service", "Dashboard"]
updated: 2026-04-23T08:56:13Z
published: 2026-04-23T09:02:33Z
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.

# 대시보드 조회

<p class="platform-info type-vpc">VPC 환경에서 이용 가능합니다.</p>

Search Engine 클러스터 정보를 확인할 수 있는 대시보드를 조회합니다.

## 요청 <a name="요청"></a>

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

| 메서드 | URI |
| :--- | :--- |
| GET | /api/v2/dashboard/getDashboardInformation/{serviceGroupInstanceNo} (한국 리전) |
| GET | /api/sgn-v2/dashboard/getDashboardInformation/{serviceGroupInstanceNo} (싱가포르 리전) |
| GET | /api/jpn-v2/dashboard/getDashboardInformation/{serviceGroupInstanceNo} (일본 리전) |

### 요청 헤더 <a name="요청헤더"></a>

Search Engine Service API에서 공통으로 사용하는 헤더에 대한 정보는 [Search Engine Service 요청 헤더](/docs/analytics-vpcsearchengine#요청헤더)를 참조해 주십시오.

### 요청 경로 파라미터 <a name="요청경로파라미터"></a>

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| :---- | :---- | :---- | :---- |
| `serviceGroupInstanceNo` | Integer | Required | 클러스터 인스턴스 번호<ul><li>[클러스터 목록 조회](/docs/analytics-vpcsearchengine-cluster-getclusterinfolist) 참조</li></ul> |

### 요청 쿼리 파라미터 <a name="요청쿼리파라미터"></a>

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| :---- | :---- | :---- | :---- |
| `pageNo` | Integer | Optional | 페이지 번호<ul><li>1~N (기본값: 1)</li></ul> |
| `pageSize` | Integer | Optional | 페이지 출력 수<ul><li>1~N (기본값: 10)</li></ul> |

### 요청 예시 <a name="요청예시"></a>

요청 예시는 다음과 같습니다.

```shell
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}' 
```

## 응답 <a name="응답"></a>

응답 형식을 설명합니다.

### 응답 바디 <a name="응답바디"></a>

응답 바디에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| :---- | :---- | :---- | :---- |
| `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 | - | 페이징 여부<ul><li>`true` \| `false`<ul><li>`true`: 페이징</li><li>`false`: 페이징 안 함</li></ul></li></ul> |
| `result.clusterIndicesStatus.indiceInfoList` | Array | - | Index 목록: [indiceInfoList](#indiceInfoList) |
| `result.clusterStatus` | Object | - | 클러스터 상태 정보 |
| `result.clusterStatus.status` | String | - | 클러스터 상태 등급<ul><li>`green` \| `yellow` \| `red` \| `blue`<ul><li>`green`: 운영 중</li><li>`yellow`: 경고</li><li> `red`: 에러</li><li> `blue`: 알 수 없음</li></ul></li></ul> |
| `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 | - | 요청에 대한 아이디<ul><li>UUID 형식</li></ul> |

#### `indiceInfoList` <a name="indiceInfoList"></a>

`indiceInfoList`에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| :---- | :---- | :---- | :---- |
| `health` | String | - | Index 상태 등급<ul><li>`green` \| `yellow` \| `red` \| `blue`<ul><li>`green`: 운영 중</li><li>`yellow`: 경고</li><li> `red`: 에러</li><li> `blue`: 알 수 없음</li></ul></li></ul> |
| `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 | - | 디스크 사용량 |

### 응답 상태 코드 <a name="응답상태코드"></a>

Search Engine Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Search Engine Service 응답 상태 코드](/docs/analytics-vpcsearchengine#응답상태코드)를 참조해 주십시오.

### 응답 예시 <a name="응답예시"></a>

응답 예시는 다음과 같습니다.

```json
{
    "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"
}
```