Search Engine Cluster 목록 조회
    • PDF

    Search Engine Cluster 목록 조회

    • PDF

    기사 요약

    설명

    Search Engine Cluster 목록을 조회합니다.

    요청

    요청 URL

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

    요청 헤더

    헤더명설명
    x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며
    API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주

    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-key네이버 클라우드 플랫폼 포털에서 발급받은 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-TypeRequest body content type을 application/json으로 지정
    Content-Type: application/json

    요청 파라미터

    파라미터타입필수 여부설명
    inputTextStringN조회할 Cluster 이름
    vpcNameStringN해당 VPC를 사용하고 있는 Cluster 조회
    pageNoIntegerN페이지 번호. Default : 1
    ex) 1, 2
    pageSizeIntegerN페이지 사이즈. Defatlt : 10
    ex) 10, 20

    요청 예시

    GET https://fin-vpcsearchengine.apigw.fin-ntruss.com/api/v2/cluster/getClusterInfoList
    ?inputText=ses
    &pageNo=1
    &pageSize=10
    &vpcName=clean
    HOST: vpcsearchengine.apigw.fin-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://fin-vpcsearchengine.apigw.fin-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 searchEngineStatus;
        private String searchEngineVersion;
        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 searchEnginePort;
        private String searchEngineDashboardPort;
        private String loginKeyName;
        private String serviceGroupInstanceNo;
        private String searchEngineUserName;
        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 searchEngineStatus;
    }
    

    필드

    파라미터명타입설명
    serviceGroupInstanceNoString생성된 Cluster의 serviceGroupInstanceNo
    allowedClustersList<AllowedClusterInfo>클러스터 목록
    disallowedClustersList<DisallowedClusterInfo>Subaccount로 호출 시 getClusterDetail 권한이 없는 Cluster 목록
    currentPageInteger현재 page
    isFirstBooleanfirst page 여부
    isLastBooleanlast page 여부
    pageSizeIntegerpage 크기
    totalCountLongCluster의 총 리스트 개수
    totalPageInteger총 page 수
    clusterNameString클러스터 이름
    dataNodeTypeString데이터 노드 타입
    dataNodeProductNameString데이터 노드 타입 이름
    dataNodeCountInteger데이터 노드 개수
    clusterStatusStringCluster 상태
    searchEngineStatusStringSearch Engine 상태
    searchEngineVersionStringSearch Engine 버전
    softwareProductNameStringOS 상품 이름
    createDateDate생성 일자
    managerNodeTypeString매니저 노드 타입
    managerNodeCountInteger매니저 노드 개수
    dataStorageVolumeSizeLong데이터 노드 Storage 크기
    managerNodeAccessControlGroupSequenceInteger매니저 노드 ACG 번호
    managerNodeAccessControlGroupNameString매니저 노드 ACG 이름
    dataNodeAccessControlGroupSequenceInteger데이터 노드 ACG 번호
    dataNodeAccessControlGroupNameString데이터 노드 ACG 이름
    searchEnginePortStringSearch Engine Port
    searchEngineDashboardPortStringSearch Engine Dashboard Port
    loginKeyNameString인증키 이름
    serviceGroupInstanceNoStringCluster 인스턴스 번호
    searchEngineUserNameStringSearch Engine 접속 아이디
    memberNoString고객 번호
    vpcNameString서버가 위치해 있는 VPC 이름
    vpcNoInteger서버가 위치해 있는 VPC 번호
    managerNodeSubnetNameString매니저 노드가 위치해 있는 Subnet 이름
    managerNodeSubnetNoInteger매니저 노드가 위치해 있는 Subnet 번호
    dataNodeSubnetNameString데이터 노드가 위치해 있는 Subnet 이름
    dataNodeSubnetNoInteger데이터 노드가 위치해 있는 Subnet 이름
    isDualManagerBoolean매니저 노드 이중화 여부
    isMasterOnlyNodeActivatedBoolean마스터 전용 노드 활성화 여부
    masterNodeAccessControlGroupSequenceInteger마스터 노드 ACG 번호
    masterNodeAccessControlGroupNameString마스터 노드 ACG 이름
    masterNodeSubnetNameString마스터 노드가 위치해 있는 Subnet 이름
    masterNodeSubnetNoInteger마스터 노드가 위치해 있는 Subnet 번호
    masterNodeTypeString마스터 노드 타입
    masterNodeProductNameString마스터 노드 타입 이름
    masterNodeCountInteger마스터 노드 개수
    isPluginInstalledBooleanObject Storage Plugin 설치 여부
    accessKeyIdStringObject 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": "vCPU 2개, 메모리 4GB, [SSD]디스크 50GB",
            "dataNodeCount": 3,
            "clusterStatus": "running",
            "searchEngineStatus": "green",
            "searchEngineVersion": "OpenSearch 1.3.3",
            "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",
             "searchEnginePort": "9200",
            "searchEngineDashboardPort": "5601",
            "loginKeyName": "testkey",
            "serviceGroupInstanceNo": "1484848",
            "searchEngineUserName": "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"
    }
    

    이 문서가 도움이 되었습니까?

    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.