Get Elasticsearch Cluster list

Article summary

Did you find this summary helpful?

Thank you for your feedback

Can be used in a VPC environment.

Description

Search a list of Search Engine Clusters.

Request

Request 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]

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/json `Content-Type: application/json`

Request parameters

Parameter	Type	Required status	Description
inputText	String	N	This is the cluster name to search.
vpcName	String	N	Search the cluster using the VPC.
pageNo	Integer	N	This is the page no. `Default : 1` ex) 1, 2
pageSize	Integer	N	This is the page size.`Default : 10` ex) 10, 20

Request example

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=" \

Response parameters

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;
}

Field

Parameter Name	Type	Description
serviceGroupInstanceNo	String	serviceGroupInstanceNo of the cluster created
allowedClusters	List<AllowedClusterInfo>	Cluster list
disallowedClusters	List<DisallowedClusterInfo>	List of clusters without getClusterDetail permissions when calling with Subaccount
currentPage	Integer	Current page
isFirst	Boolean	Whether it's the first page
isLast	Boolean	Whether it's the last page
pageSize	Integer	Page size
totalCount	Long	Total number of the cluster's lists
totalPage	Integer	Total page no.
clusterName	String	Cluster name
dataNodeType	String	Data node type
dataNodeProductName	String	Data node type name
dataNodeCount	Integer	Number of data nodes
clusterStatus	String	Cluster status
elasticSearchStatus	String	Elasticsearch status
elasticSearchVersion	String	Elasticsearch version
softwareProductName	String	OS product name
createDate	Date	Created date
managerNodeType	String	Manager node type
managerNodeCount	Integer	Number of manager nodes
dataStorageVolumeSize	Long	Data node storage size
managerNodeAccessControlGroupSequence	Integer	ACG no. of the manager node
managerNodeAccessControlGroupName	String	ACG name of the manager node
dataNodeAccessControlGroupSequence	Integer	ACG no. of the data node
dataNodeAccessControlGroupName	String	ACG name of the data node
elasticSearchHttpPort	String	Elasticsearch HTTP Port
kibanaHttpPort	String	Kibana HTTP Port
loginKeyName	String	Authentication key name
serviceGroupInstanceNo	String	Cluster instance no.
kibanaUserName	String	Kibana connection ID
memberNo	String	Customer no.
vpcName	String	Name of the VPC where the server is located
vpcNo	Integer	No. of the VPC where the server is located
managerNodeSubnetName	String	Name of the subnet where the manager node is located
managerNodeSubnetNo	Integer	No. of the subnet where the manager node is located
dataNodeSubnetName	String	Name of the subnet where the data node is located
dataNodeSubnetNo	Integer	Name of the subnet where the data node is located
isDualManager	Boolean	Manager node duplexing status
isMasterOnlyNodeActivated	Boolean	Dedicated master node activation status
masterNodeAccessControlGroupSequence	Integer	Master node ACG number
masterNodeAccessControlGroupName	String	Master node ACG name
masterNodeSubnetName	String	Name of the subnet where the master node is located
masterNodeSubnetNo	Integer	Number of the subnet where the master node is located
masterNodeType	String	Master node type
masterNodeProductName	String	Master node type name
masterNodeCount	Integer	Number of master nodes
isPluginInstalled	Boolean	Object Storage plugin installation status
accessKeyId	String	API access key for Object Storage access

Response example

{
  "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": "2 vCPUs, 4 GB memory, 50 GB [SSD] disk",
        "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": "searchengine-m-vtps",
        "dataNodeAccessControlGroupSequence": 62221,
        "dataNodeAccessControlGroupName": "searchengine-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"
}

Was this article helpful?

What's Next

Get Search Engine Cluster Data node

Table of contents

Description
Request
Response parameters
Field