getServerInstanceList
- 인쇄
- PDF
getServerInstanceList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
서버 인스턴스(VM) 리스트를 조회합니다. 페이징 처리가 가능하며, 응답필드 중 userData의 경우에는 서버 인스턴스 상세 조회 시에만 제공됩니다.
요청
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| serverInstanceNoList.N | No | List<String> | - 조회할 서버 인스턴스 번호 리스트 serverInstanceNo는 getServerInstanceList 액션을 통해 획득 가능 ex) serverInstanceNoList.1=937507&serverInstanceNoList.2=1021003 | |
| searchFilterName | No | String | - 검색할 필터명 서버 이름과 아이피(ip)로 필터링하여 검색 가능 아이피(ip)의 경우에는 사설 아이피, 공인 아이피 모두 검색 가능 Options : serverName (서버 이름) | ip (아이피 주소) [대소문자 구분 없음]searchFilterName은 아래의 searchFilterValue 값과 mapping하여 사용 ex) searchFilterName=ip&searchFilterValue=10.41.3.81 ex) searchFilterName=serverName&searchFilterValue=monkeys | |
| searchFilterValue | No | String | - 검색할 필터값 위의 searchFilterName 값과 mapping할 값을 입력 | |
| pageNo | No | Integer | Min:0, Max:2147483647 | - 페이징된 결과의 페이지 번호 결과값을 pageNo를 이용하여 페이징 처리 가능 |
| pageSize | No | Integer | Min:0, Max:2147483647 | - 페이징 시 보여줄 각 페이지 사이즈 결과값을 pageSize를 이용하여 페이징 처리 가능 |
| serverInstanceStatusCode | No | String | Min:0, Max:5 | - 서버인스턴스상태코드 조회할 서버 인스턴스 상태코드별 서버 리스트 serverInstanceStatusCode getServerInstanceList 액션을 통해 획득 입력 가능한 상태는 서버 인스턴스 데이터 타입(ServerInstance)의 서버 인스턴스 상태(serverInstanceStatus) 값 참고 ex) serverInstanceStatusCode=NSTOP |
| regionNo | No | String | - 리전 번호 서버 리스트가 조회될 리전(Region) 결정 regionNo는 getRegionList 액션을 통해 획득 가능 | |
| zoneNo | No | String | - ZONE번호 서버 리스트가 조회될 존(zone) 결정 zoneNo는 getZoneList 액션을 통해 획득 가능 default : 해당 리전의 첫 번째 존(zone)을 선택 | |
| baseBlockStorageDiskTypeCode | No | String | Min : 1, Max : 5 | - 서버 디스크 유형 구분 코드 Options : NET (NETWORK DISK) | LOCAL (LOCAL DISK) |
| baseBlockStorageDiskDetailTypeCode | No | String | Min : 1, Max : 5 | - 서버 디스크 상세 유형 구분코드 Options : HDD | SSD |
| sortedBy | No | String | - 정렬 대상 서버 이름과 서버 인스턴스 번호로 정렬 Options : serverName (서버 이름) | serverInstanceNo (서버 인스턴스 번호) [대소문자 구분 없음]default : serverInstanceNo sortedBy는 아래의 sortingOrder와 mapping하여 사용 ex) sortedBy=serverName&sortingOrder=ascending ex) sortedBy=serverInstanceNo&sortingOrder=descending | |
| sortingOrder | No | String | - 정렬 순서 위에서 설정한 sortedBy의 오름차순/내림차순 정렬 설정 ascending (오름차순) | descending (내림차순) [대소문자 구분 없음]default : ascending | |
| serverInstanceTypeCodeList.N | No | List<String> | - 조회할 서버 인스턴스 구분 코드 리스트 입력 가능한 상태는 서버 인스턴스 데이터 타입(ServerInstance)의 서버 인스턴스 타입(serverInstanceType) 값 참고 Options : MICRO (Micro) | COMPT (Compact) | STAND(Standard) | HIMEM(High Memory) | GPU(GPU) | VDS (Virtual Dedicated Server) | |
| tagKeyList.N | No | List<String> | - 조회할 인스턴스의 태그 키 인스턴스의 태그 키를 통해 인스턴스 조회 가능 Instance의 TagKey는 getInstanceTagList 액션을 통해 획득 가능 ex) instanceTagList.1.tagKey=tag1 | |
| tagKeyValue.N | No | List<String> | - 조회할 인스턴스의 태그 값 인스턴스의 태그 값을 통해 인스턴스 조회 가능 Instance의 TagValue는 getInstanceTagList 액션을 통해 획득 가능 ex) instanceTagList.1.tagValue=dolphins |
응답
응답 바디
예시
요청 예시
GET {SERVER_API_URL}/getServerInstanceList
?serverInstanceStatusCode=RUN
&searchFilterName=ip
&searchFilterValue=106.10.46.237
응답 예시
<getServerInstanceListResponse>
<requestId>0cf1cb98-6fdb-4064-804d-c1a14f903d9b</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<serverInstanceList>
<serverInstance>
<serverInstanceNo>1081368</serverInstanceNo>
<serverName>s1673fa87a9b</serverName>
<serverDescription></serverDescription>
<cpuCount>1</cpuCount>
<memorySize>1073741824</memorySize>
<baseBlockStorageSize>53687091200</baseBlockStorageSize>
<platformType>
<code>LNX32</code>
<codeName>Linux 32 Bit</codeName>
</platformType>
<loginKeyName>juhoon-kim</loginKeyName>
<isFeeChargingMonitoring>false</isFeeChargingMonitoring>
<publicIp></publicIp>
<privateIp>10.41.19.248</privateIp>
<serverImageName>centos-6.3-32</serverImageName>
<serverInstanceStatus>
<code>NSTOP</code>
<codeName>Server normal stopped state</codeName>
</serverInstanceStatus>
<serverInstanceOperation>
<code>NULL</code>
<codeName>Server NULL OP</codeName>
</serverInstanceOperation>
<serverInstanceStatusName>stopped</serverInstanceStatusName>
<createDate>2018-11-23T17:21:05+0900</createDate>
<uptime>2018-11-23T17:36:40+0900</uptime>
<serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
<serverProductCode>SPSVRSTAND000056</serverProductCode>
<isProtectServerTermination>false</isProtectServerTermination>
<portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
<zone>
<zoneNo>3</zoneNo>
<zoneName>KR-2</zoneName>
<zoneCode>KR-2</zoneCode>
<zoneDescription>평촌 zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<baseBlockStorageDiskType>
<code>NET</code>
<codeName>Network Storage</codeName>
</baseBlockStorageDiskType>
<baseBlockStorageDiskDetailType>
<code>HDD</code>
<codeName>HDD</codeName>
</baseBlockStorageDiskDetailType>
<serverInstanceType>
<code>MICRO</code>
<codeName>Micro Server</codeName>
</serverInstanceType>
<userData></userData>
<initScriptNo></initScriptNo>
<accessControlGroupList>
<accessControlGroup>
<accessControlGroupConfigurationNo>39995</accessControlGroupConfigurationNo>
<accessControlGroupName>ncloud-default-acg</accessControlGroupName>
<accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
<isDefault>true</isDefault>
<createDate>2018-04-09T11:12:54+0900</createDate>
</accessControlGroup>
</accessControlGroupList>
<instanceTagList/>
</serverInstance>
</serverInstanceList>
</getServerInstanceListResponse>
이 문서가 도움이 되었습니까?