Search Engine Cluster Dashboard 조회

VPC 환경에서 이용 가능합니다.

설명

클러스터의 정보(클러스터 상태, index 정보)를 조회합니다.

요청

요청 URL

GET https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/dashboard/getDashboardInformation/{service-group-instance-no}?pageNo={pageNo}&pageSize={pageSize} [수도권]
GET https://vpcsearchengine.apigw.gov-ntruss.com/api/krs-v2/dashboard/getDashboardInformation/{service-group-instance-no}?pageNo={pageNo}&pageSize={pageSize} [남부권]

요청 헤더

요청 파라미터

요청 예시

POST https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/dashboard/getDashboardInformation/1484848?pageNo=1&pageSize=10
HOST: vpcsearchengine.apigw.gov-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.gov-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;
}

필드

응답 예시

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