Search Engine Clusterリストの照会

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]

リクエストヘッダ

リクエストパラメータ

リクエスト例

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

フィールド

レスポンス例

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