Search Engine Cluster Dashboard 조회
- 인쇄
- PDF
Search Engine Cluster Dashboard 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
설명
클러스터의 정보(클러스터 상태, index 정보)를 조회합니다.
요청
요청 URL
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/dashboard/getDashboardInformation/{service-group-instance-no}?pageNo={pageNo}&pageSize={pageSize} [KR]
GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/dashboard/getDashboardInformation/{service-group-instance-no}?pageNo={pageNo}&pageSize={pageSize} [SGN]
GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/dashboard/getDashboardInformation/{service-group-instance-no}?pageNo={pageNo}&pageSize={pageSize} [JPN]
요청 헤더
| 헤더명 | 설명 |
|---|---|
| x-ncp-apigw-timestamp | - 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타냄 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Access Key ID 값과 Secret Key로 암호화한 서명x-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Request body content type을 application/json으로 지정Content-Type: application/json |
요청 파라미터
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| serviceGroupInstanceNo | String | Y | 조회할 Cluster의 번호 |
| pageNo | Integer | N | - 페이지 번호Default : 1- <예시> 1, 2 |
| pageSize | Integer | N | - 페이지 사이즈Defatlt : 10- <예시> 10, 20 |
요청 예시
POST https://vpcsearchengine.apigw.ntruss.com/api/v2/dashboard/getDashboardInformation/1484848?pageNo=1&pageSize=10
HOST: vpcsearchengine.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
curl -X POST "https://vpcsearchengine.apigw.ntruss.com/api/v2/dashboard/getDashboardInformation/1484848?pageNo=1&pageSize=10 \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4="
응답 파라미터
public class GetDashboardInformationResponseVo {
GetClusterIndicesStatusResponseVo clusterIndicesStatus;
GetClusterStatusResponseVo clusterStatus;
}
public class GetClusterIndicesStatusResponseVo {
private Integer pageSize;
private Integer currentPage;
private Integer totalPage;
private Integer totalCount;
private Boolean isPaged = true;
private List<CatIndice> indiceInfoList;
}
public class CatIndice {
String health;
String status;
String indexName;
String uuid;
String primaryCount;
String replicaCount;
String docsCount;
String docsDeleted;
String storeSize;
String priStoreSize;
}
public class GetClusterStatusResponseVo {
String status;
String indicesCount;
String shardCount;
String docsCount;
String storeSizeInUsed;
String segmentsCount;
}
필드
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| clusterIndicesStatus | GetClusterIndicesStatusResponseVo | Index 정보 |
| clusterStatus | GetClusterStatusResponseVo | Cluster 상태 |
| pageSize | Integer | page 크기 |
| currentPage | Integer | 현재 page |
| totalCount | Long | Index의 총 개수 |
| totalPage | Integer | 총 page 수 |
| isPaged | Boolean | paging 여부(true) |
| indiceInfoList | List<CatIndice> | Index 목록 |
| health | String | Index health |
| status | String | Index status |
| indexName | String | Index 이름 |
| primaryCount | String | primary shard 개수 |
| replicaCount | String | replica shard 개수 |
| docsCount | String | document 개수 |
| docsDeleted | String | 삭제된 document 개수 |
| storeSize | String | 사용 용량 |
| indicesCount | String | Index 개수 |
| shardCount | String | shard 개수 |
| storeSizeInUsed | String | 사용 총 용량 |
| segmentsCount | String | segment 개수 |
응답 예시
{
"code": 0,
"message": "SUCCESS",
"result": {
"clusterIndicesStatus": {
"pageSize": 10,
"currentPage": 1,
"totalPage": 1,
"totalCount": 1,
"isPaged": true,
"indiceInfoList": [
{
"health": "green",
"status": "open",
"indexName": ".kibana_1",
"uuid": "VW8OLgiuS56aeErYoXpEig",
"primaryCount": "1",
"replicaCount": "1",
"docsCount": "1",
"docsDeleted": "0",
"storeSize": "7.6kb"
}
]
},
"clusterStatus": {
"status": "green",
"indicesCount": "1",
"shardCount": "2",
"docsCount": "1",
"storeSizeInUsed": "7.6kb",
"segmentsCount": "2"
}
},
"requestId": "9f97d84e-b662-46e2-a82e-58d995c6f4fc"
}
이 문서가 도움이 되었습니까?