Get Search Engine Cluster Dashboard
- Print
- PDF
Get Search Engine Cluster Dashboard
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Description
Search a cluster's information (cluster status and index information).
Request
Request 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]
Request headers
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | This is the Access Key ID value issued by the Naver Cloud Platform portal.x-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | This is the signature encrypted Access Key ID value and Secret Key.x-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specifies the request body content type as application/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Required status | Description |
|---|---|---|---|
| serviceGroupInstanceNo | String | Y | This is the cluster no. to search. |
| pageNo | Integer | N | This is the page no. Default : 1ex) 1, 2 |
| pageSize | Integer | N | This is the page size. Default : 10ex) 10, 20 |
Request example
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="
Response parameters
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;
}
Field
| Parameter Name | Type | Description |
|---|---|---|
| clusterIndicesStatus | GetClusterIndicesStatusResponseVo | Index information |
| clusterStatus | GetClusterStatusResponseVo | Cluster status |
| pageSize | Integer | Page size |
| currentPage | Integer | Current page |
| totalCount | Long | Total number of indices |
| totalPage | Integer | Total page no. |
| isPaged | Boolean | Paging status (true) |
| indiceInfoList | List<CatIndice> | List of indices |
| health | String | Index health |
| status | String | Index status |
| indexName | String | Index name |
| primaryCount | String | Number of primary shards |
| replicaCount | String | Number of replica shards |
| docsCount | String | Number of documents |
| docsDeleted | String | Number of documents deleted |
| storeSize | String | Storage in use |
| indicesCount | String | Number of indices |
| shardCount | String | Number of shards |
| storeSizeInUsed | String | Total storage in use |
| segmentsCount | String | Number of segments |
Response example
{
"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"
}
Was this article helpful?