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-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもので、
    API Gatewayサーバとの時間差が5分以上の場合、有効ではないリクエストとみなす
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyNAVERクラウドプラットフォームのポータルから発行されたAccess Key ID値
    x-ncp-iam-access-key:{Account Access Key}
    x-ncp-apigw-signature-v2Access Key ID値とSecret Keyで暗号化した署名
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-Typeリクエストボディーcontent typeをapplication/jsonに指定
    Content-Type: application/json

    リクエストパラメータ

    パラメータタイプ必須有無説明
    serviceGroupInstanceNoStringY照会するクラスタの番号です。
    pageNoIntegerNページ番号です。Default : 1
    ex) 1, 2
    pageSizeIntegerNページサイズです。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;
    }
    

    フィールド

    パラメータ名タイプ説明
    clusterIndicesStatusGetClusterIndicesStatusResponseVoIndex情報
    clusterStatusGetClusterStatusResponseVoクラスタの状態
    pageSizeIntegerページのサイズ
    currentPageInteger現在のページ
    totalCountLongIndexの総数
    totalPageInteger総ページ数
    isPagedBooleanpagingの有無(true)
    indiceInfoListList<CatIndice>Indexリスト
    healthStringIndex health
    statusStringIndex status
    indexNameStringIndex名
    primaryCountStringprimary shard数
    replicaCountStringreplica shard数
    docsCountStringdocument数
    docsDeletedString削除されたdocument数
    storeSizeString使用容量
    indicesCountStringIndex数
    shardCountStringshard数
    storeSizeInUsedString総使用容量
    segmentsCountStringsegment数

    レスポンス例

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

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.