Search Engine Cluster 목록 조회
- 인쇄
- PDF
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 | 네이버 클라우드 플랫폼 포털에서 발급받은 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 | Request body content type을 application/json으로 지정Content-Type: application/json |
요청 파라미터
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
inputText | String | N | 조회할 Cluster의 이름 |
vpcName | String | N | 해당 VPC를 사용하고 있는 Cluster 조회 |
pageNo | Integer | N | 페이지 번호 Default : 1 <예시> 1, 2 |
pageSize | Integer | N | 페이지 사이즈Defatlt : 10 <예시> 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 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;
}
필드
파라미터명 | 타입 | 설명 |
---|---|---|
serviceGroupInstanceNo | String | 생성된 Cluster의 serviceGroupInstanceNo |
allowedClusters | List<AllowedClusterInfo> | 클러스터 목록 |
disallowedClusters | List<DisallowedClusterInfo> | Subaccount로 호출 시 getClusterDetail 권한이 없는 Cluster 목록 |
currentPage | Integer | 현재 page |
isFirst | Boolean | first page 여부 |
isLast | Boolean | last page 여부 |
pageSize | Integer | page 크기 |
totalCount | Long | Cluster의 총 리스트 개수 |
totalPage | Integer | 총 page 수 |
clusterName | String | 클러스터 이름 |
dataNodeType | String | 데이터 노드 타입 |
dataNodeProductName | String | 데이터 노드 타입 이름 |
dataNodeCount | Integer | 데이터 노드 개수 |
clusterStatus | String | Cluster 상태 |
searchEngineStatus | String | Search Engine 상태 |
searchEngineVersion | String | Search Engine 버전 |
softwareProductName | String | OS 상품 이름 |
createDate | Date | 생성 일자 |
managerNodeType | String | 매니저 노드 타입 |
managerNodeCount | Integer | 매니저 노드 개수 |
dataStorageVolumeSize | Long | 데이터 노드 Storage 크기 |
managerNodeAccessControlGroupSequence | Integer | 매니저 노드 ACG 번호 |
managerNodeAccessControlGroupName | String | 매니저 노드 ACG 이름 |
dataNodeAccessControlGroupSequence | Integer | 데이터 노드 ACG 번호 |
dataNodeAccessControlGroupName | String | 데이터 노드 ACG 이름 |
searchEnginePort | String | Search Engine Port |
searchEngineDashboardPort | String | Search Engine Dashboard Port |
loginKeyName | String | 인증키 이름 |
serviceGroupInstanceNo | String | Cluster 인스턴스 번호 |
searchEngineUserName | String | Search Engine 접속 아이디 |
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": "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"
}
이 문서가 도움이 되었습니까?