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	NAVERクラウドプラットフォームのポータルから発行された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	リクエストボディーcontent typeをapplication/jsonに指定 `Content-Type: application/json`

リクエストパラメータ

パラメータ	タイプ	必須有無	説明
serviceGroupInstanceNo	String	Y	照会するクラスタの番号です。
pageNo	Integer	N	ページ番号です。`Default : 1` ex) 1, 2
pageSize	Integer	N	ページサイズです。`Default : 10` ex) 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	クラスタの状態
pageSize	Integer	ページのサイズ
currentPage	Integer	現在のページ
totalCount	Long	Indexの総数
totalPage	Integer	総ページ数
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"
}

この記事は役に立ちましたか?

What's Next

Search Engine Monitoringデータを照会

説明
リクエスト
レスポンスパラメータ
フィールド

タグ

Search Engine Service