Search Engine Clusterリストの照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

説明

Search Engine Clusterリストを照会します。

リクエスト

リクエストURL

GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfoList
?inputText={inputText}
&pageNo={pageNo}
&pageSize={pageSize}
&vpcName={vpcName} [KR]

GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getClusterInfoList
?inputText={inputText}
&pageNo={pageNo}
&pageSize={pageSize}
&vpcName={vpcName} [SGN]

GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getClusterInfoList
?inputText={inputText}
&pageNo={pageNo}
&pageSize={pageSize}
&vpcName={vpcName} [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`

リクエストパラメータ

パラメータ	タイプ	必須有無	説明
inputText	String	N	照会するクラスタ名です。
vpcName	String	N	当該VPCを使用しているクラスタを照会します。
pageNo	Integer	N	ページ番号です。`Default : 1` ex) 1, 2
pageSize	Integer	N	ページサイズです。`Default : 10` ex) 10, 20

リクエスト例

GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfoList
?inputText=ses
&pageNo=1
&pageSize=10
&vpcName=clean
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 GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfoList?inputText=ses&
pageNo=1
&pageSize=10
&vpcName=clean \
-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 GetClusterInfoListResponseVo {
    private List<AllowedClusterInfo> allowedClusters;
    private List<DisallowedClusterInfo> disallowedClusters;
    private Integer currentPage;
    private Boolean isFirst;
    private Boolean isLast;
    private Integer pageSize;
    private Long totalCount;
    private Integer totalPage;
}

public class AllowedClusterInfo {
    private String clusterName;
    private String dataNodeType;
    private String dataNodeProductName;
    private Integer dataNodeCount;
    private String clusterStatus;
    private String elasticSearchStatus;
    private String elasticSearchVersion;
    private String softwareProductName;
    private Date createDate;
    private String managerNodeType;
    private Integer managerNodeCount;
    private Long dataStorageVolumeSize;
    private Integer managerNodeAccessControlGroupSequence;
    private String managerNodeAccessControlGroupName;
    private Integer dataNodeAccessControlGroupSequence;
    private String dataNodeAccessControlGroupName;
    private String elasticSearchHttpPort;
    private String kibanaHttpPort;
    private String loginKeyName;
    private String serviceGroupInstanceNo;
    private String kibanaUserName;
    private String memberNo;
    private String vpcName;
    private Integer vpcNo;
    private String managerNodeSubnetName;
    private Integer managerNodeSubnetNo;
    private String dataNodeSubnetName;
    private Integer dataNodeSubnetNo;
    private Boolean isMasterOnlyNodeActivated;
    private Integer masterNodeAccessControlGroupSequence;
    private String masterNodeAccessControlGroupName;
    private String masterNodeSubnetName;
    private Integer masterNodeSubnetNo;
    private String masterNodeType;
    private String masterNodeProductName;
    private Integer masterNodeCount;
    private Boolean isPluginInstalled;
    private String accessKeyId;
}

public class DisallowedClusterInfo {
    private String clusterName;
    private String clusterStatus;
    private String elasticSearchStatus;
}

フィールド

パラメータ名	タイプ	説明
serviceGroupInstanceNo	String	作成されたクラスタのserviceGroupInstanceNo
allowedClusters	List<AllowedClusterInfo>	クラスタリスト
disallowedClusters	List<DisallowedClusterInfo>	Subaccountで呼び出す際、getClusterDetail権限がないクラスタリスト
currentPage	Integer	現在のページ
isFirst	Boolean	firstページかどうか
isLast	Boolean	lastページかどうか
pageSize	Integer	ページのサイズ
totalCount	Long	クラスタの総リスト数
totalPage	Integer	総ページ数
clusterName	String	クラスタ名
dataNodeType	String	データノードタイプ
dataNodeProductName	String	データノードタイプ名
dataNodeCount	Integer	データノード数
clusterStatus	String	クラスタの状態
elasticSearchStatus	String	Elasticsearchの状態
elasticSearchVersion	String	Elasticsearchバージョン
softwareProductName	String	OS商品名
createDate	Date	作成日時
managerNodeType	String	マネージャーノードタイプ
managerNodeCount	Integer	マネージャーノード数
dataStorageVolumeSize	Long	データノードのストレージ容量
managerNodeAccessControlGroupSequence	Integer	マネージャーノードのACG番号
managerNodeAccessControlGroupName	String	マネージャーノードのACG名
dataNodeAccessControlGroupSequence	Integer	データノードのACG番号
dataNodeAccessControlGroupName	String	データノードのACG名
elasticSearchHttpPort	String	Elasticsearch HTTP Port
kibanaHttpPort	String	Kibana HTTP Port
loginKeyName	String	認証キー名
serviceGroupInstanceNo	String	クラスタインスタンス番号
kibanaUserName	String	KibanaアクセスID
memberNo	String	お客様番号
vpcName	String	サーバが位置しているVPC名
vpcNo	Integer	サーバが位置しているVPC番号
managerNodeSubnetName	String	マネージャーノードが位置しているSubnet名
managerNodeSubnetNo	Integer	マネージャーノードが位置しているSubnet番号
dataNodeSubnetName	String	データノードが位置しているSubnet名
dataNodeSubnetNo	Integer	データノードが位置しているSubnet名
isDualManager	Boolean	マネージャーノードの二重化有無
isMasterOnlyNodeActivated	Boolean	マスター専用ノードの有効化有無
masterNodeAccessControlGroupSequence	Integer	マスターノードのACG番号
masterNodeAccessControlGroupName	String	マスターノードのACG名
masterNodeSubnetName	String	マスターノードが位置しているSubnet名
masterNodeSubnetNo	Integer	マスターノードが位置しているSubnet番号
masterNodeType	String	データノードのタイプ
masterNodeProductName	String	マスターノードのタイプ名
masterNodeCount	Integer	マスターノード数
isPluginInstalled	Boolean	Object Storage Pluginのインストール有無
accessKeyId	String	Object Storageアクセス用API Access Key

レスポンス例

{
  "code": 0,
  "message": "SUCCESS",
  "result": {
    "currentPage": 1,
    "isFirst": true,
    "isLast": true,
    "pageSize": 10,
    "totalCount": 1,
    "totalPage": 1,
    "allowedClusters": [
      {
        "clusterName": "openapitest11",
        "dataNodeType": "2vCPU, 4GB Mem",
        "dataNodeProductName": "vCPU2個、メモリ4GB、[SSD]ディスク50GB",
        "dataNodeCount": 3,
        "clusterStatus": "running",
        "elasticSearchStatus": "green",
        "elasticSearchVersion": "ElasticSearch-OSS 7.7.0",
        "softwareProductName": "CentOS 7.3 (64-bit)",
        "createDate": "2020-10-06 18:06:40",
        "managerNodeType": "2vCPU, 4GB Mem",
        "managerNodeCount": 2,
        "dataStorageVolumeSize": 322122547200,
        "managerNodeAccessControlGroupSequence": 62222,
        "managerNodeAccessControlGroupName": "elasticsearch-m-vtps",
        "dataNodeAccessControlGroupSequence": 62221,
        "dataNodeAccessControlGroupName": "elasticsearch-d-vtps",
        "elasticSearchHttpPort": "9200",
        "kibanaHttpPort": "5601",
        "loginKeyName": "testkey",
        "serviceGroupInstanceNo": "1484848",
        "kibanaUserName": "test",
        "memberNo": "774",
        "vpcName": "test",
        "vpcNo": 36752,
        "managerNodeSubnetName": "testpri | KR-1 | Private",
        "managerNodeSubnetNo": 22630,
        "dataNodeSubnetName": "testpri | KR-1 | Private",
        "dataNodeSubnetNo": 22630,
        "isPluginInstalled": true,
        "isDualManager": true,
        "accessKeyId": null,
        "isMasterOnlyNodeActivated": false,
        "masterNodeAccessControlGroupSequence": null,
        "masterNodeAccessControlGroupName": null,
        "masterNodeSubnetName": null,
        "masterNodeSubnetNo": null,
        "masterNodeType": null,
        "masterNodeProductName": null,
        "masterNodeCount": null,
      }
    ],
    "disallowedClusters": []
  },
  "requestId": "857c253d-a8b7-4795-983a-b50c15f180a2"
}

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

What's Next

Search Engine Clusterデータノードの照会

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

タグ

Search Engine Service