VPC 환경에서 이용 가능합니다.
개요
공인 IP 인스턴스 리스트를 조회합니다.
요청
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| regionCode | No | String | - 리전 코드 공인 IP 인스턴스 리스트가 조회될 리전(Region) 결정 가능 regionCode는 getRegionList 액션을 통해 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전을 선택 |
|
| publicIpInstanceNoList.N | No | List<String> | - 공인 IP 인스턴스 번호 리스트 공인 IP 인스턴스 번호로 필터링하여 검색 가능 publicIpInstanceNo는 getPublicIpInstanceList 액션을 통해 획득 가능 ex) --publicIpInstanceNoList 1234 2345 |
|
| publicIp | No | String | - 공인 IP 주소 공인 IP 주소로 필터링하여 검색 가능 |
|
| privateIp | No | String | - 비공인 IP 주소 공인 IP 인스턴스가 할당된 서버 인스턴스의 eth0 비공인 IP 주소로 필터링하여 검색 가능 |
|
| isAssociated | No | Boolean | - 할당 여부 서버 인스턴스에 할당된 공인 IP와 할당 되지 않은 공인 IP로 필터링하여 검색 가능 Options : true | false |
|
| serverName | No | String | - 서버 이름 공인 IP 인스턴스가 할당된 서버 이름으로 필터링하여 검색 가능 |
|
| publicIpInstanceStatusCode | No | String | - 공인 IP 인스턴스 상태 코드 공인 IP 인스턴스의 상태 코드로 필터링하여 검색 가능 Options : INIT | SET | RUN | TERMTING |
|
| pageNo | No | Integer | - 페이징된 결과의 페이지 번호 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 |
|
| pageSize | Conditional | Integer | - 페이징 시 보여줄 각 페이지 사이즈 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력시 반드시 입력 필요 |
|
| vpcNo | No | String | - VPC 번호 VPC 번호로 필터링하여 검색 가능 vpcNo는 getVpcList 액션을 통해 획득 가능 |
|
| responseFormatType | No | String | - 응답 결과의 포맷 타입 Options : xml | json Default : xml |
응답
응답 데이터 타입
- PublicIpInstanceList 타입
| PublicIpInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<PublicIpInstance> publicIpInstanceList = new ArrayList<>(); |
| PublicIpInstance |
|---|
| private String publicIpInstanceNo; |
| private String publicIp; |
| private String publicIpDescription; |
| private Date createDate; |
| private String publicIpInstanceStatusName; |
| private CommonCode publicIpInstanceStatus; |
| private String serverInstanceNo; |
| private String serverName; |
| private String privateIp; |
| private Date lastModifyDate; |
| private CommonCode publicIpInstanceOperation; |
예시
요청 예시
ncloud vserver getPublicIpInstanceList --regionCode KR --publicIpInstanceNoList ***7551 ***7552 --publicIp ***.***.111.215 --privateIp ***.***.1.6 --isAssociated true --serverName test-*** --publicIpInstanceStatusCode RUN --vpcNo ***04
응답 예시
<getPublicIpInstanceListResponse>
<requestId>ff28f839-00f2-4d07-bd6b-b172596eebf8</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<publicIpInstanceList>
<publicIpInstance>
<publicIpInstanceNo>***7551</publicIpInstanceNo>
<publicIp>***.***.111.215</publicIp>
<publicIpDescription></publicIpDescription>
<createDate>2020-08-19T14:34:41+0900</createDate>
<publicIpInstanceStatusName>운영중</publicIpInstanceStatusName>
<publicIpInstanceStatus>
<code>RUN</code>
<codeName>run</codeName>
</publicIpInstanceStatus>
<serverInstanceNo>***4299</serverInstanceNo>
<serverName>test-***</serverName>
<privateIp>***.***.1.6</privateIp>
<publicIpInstanceOperation>
<code>NULL</code>
<codeName>NULL OP</codeName>
</publicIpInstanceOperation>
</publicIpInstance>
</publicIpInstanceList>
</getPublicIpInstanceListResponse>