getPublicIpInstanceList
- 인쇄
- PDF
getPublicIpInstanceList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
공인 IP 인스턴스 리스트 조회
설명
공인 IP 인스턴스 리스트를 조회합니다.
요청 파라미터
파라미터 명 | 필수 여부 | 타입 | 제약사항 | 설명 |
---|---|---|---|---|
isAssociated | No | Boolean | 할당된 공인IP, 할당되지 않은 공인IP 조회 가능 | |
publicIpInstanceNoList | No | List | 중복 불가 | 조회할 공인 IP 인스턴스 번호 리스트 |
publicIpList | No | String | Min : 5, Max : 15 | 조회할 공인 IP 리스트 |
searchFilterName | No | String | 공인 아이피(publicIp) | 할당된 서버 명(associatedServerName) | |
searchFilterValue | No | String | 조회할 값 | |
regionNo | No | String | 입력 가능한 상태는 getRegionList 액션을 통해 획득 가능 | |
zoneNo | No | String | 공인 IP 인스턴스 리스트를 ZONE을 이용해 필터링 가능 필터를 설정하지 않으면 해당 리전의 ZONE에 속한 공인 IP 리스트가 모두 선택됨 | |
pageNo | No | Integer | Min : 0, Max : 2147483647 | 건수가 많을 경우 페이지 사이즈에 해당하는 페이지 번호 |
pageSize | No | Integer | Min : 0, Max : 2147483647 | 한 페이지에서 조회할 페이지 사이즈 |
sortedBy | No | String | 목록 결과에 대한 정렬 컬럼을 정할 수 있음 공인 IP(publicIp) | 공인 IP 인스턴스 번호(publicIpInstanceNo) [대소문자 구분 없음] Default : 공인 IP 인스턴스 번호(publicIpInstanceNo) | |
sortingOrder | No | String | 오름차순 내림차순에 대한 목록 결과에 ordering을 정할 수 있음 오름차순(ascending) | 내림차순(descending) [대소문자 구분 없음] Default : 오름차순(ascending) |
응답 데이터 타입
- PublicIpInstanceList 타입
PublicIpInstanceList extends CommonResponse |
---|
private Integer totalRows; |
private List |
PublicIpInstance |
---|
private String publicIpInstanceNo; |
private String publiclIp; |
private String publicIpDescription; |
private Date createDate; |
private String publicIpInstanceStatusName; |
private CommonCode publicIpInstanceStatus; |
private CommonCode publicIpInstanceOperation; |
private CommonCode publicIpKindType; |
private ServerInstance serverInstanceAssociatedWithPublicIp; |
private Region region; |
private Zone zone; |
예시
호출
ncloud server getPublicIpInstanceList --publicIpList 192.168.60.117 192.168.60.115
응답
{
"getPublicIpInstanceListResponse": {
"requestId": "dbf5e5bc-97c0-4164-9ee5-1128e50f5617",
"returnCode": "0",
"returnMessage": "success",
"totalRows": 2,
"publicIpInstanceList": [
{
"publicIpInstanceNo": "396562",
"publicIp": "192.168.60.115",
"publicIpDescription": "",
"createDate": "2018-02-13T13:46:23+0900",
"publicIpInstanceStatusName": "created",
"publicIpInstanceStatus": {
"code": "CREAT",
"codeName": "NET CREAT State"
},
"publicIpInstanceOperation": {
"code": "NULL",
"codeName": "NET NULL OP"
},
"publicIpKindType": {
"code": "GEN",
"codeName": "General"
},
"serverInstanceAssociatedWithPublicIp": {},
"zone": {
"zoneNo": "2",
"zoneName": "KR-1",
"zoneCode": "KR-1",
"zoneDescription": "KR-1 zone",
"regionNo" : "1"
}
},
{
"publicIpInstanceNo": "397030",
"publicIp": "192.168.60.117",
"publicIpDescription": "test",
"createDate": "2018-02-20T21:32:24+0900",
"publicIpInstanceStatusName": "created",
"publicIpInstanceStatus": {
"code": "CREAT",
"codeName": "NET CREAT State"
},
"publicIpInstanceOperation": {
"code": "NULL",
"codeName": "NET NULL OP"
},
"publicIpKindType": {
"code": "GEN",
"codeName": "General"
},
"serverInstanceAssociatedWithPublicIp": {},
"zone": {
"zoneNo": "2",
"zoneName": "KR-1",
"zoneCode": "KR-1",
"zoneDescription": "KR-1 zone",
"regionNo" : "1"
}
}
]
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<getPublicIpInstanceListResponse>
<requestId>dbf5e5bc-97c0-4164-9ee5-1128e50f5617</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>2</totalRows>
<publicIpInstanceList>
<publicIpInstanceNo>396562</publicIpInstanceNo>
<publicIp>192.168.60.115</publicIp>
<publicIpDescription></publicIpDescription>
<createDate>2018-02-13T13:46:23+0900</createDate>
<publicIpInstanceStatusName>created</publicIpInstanceStatusName>
<publicIpInstanceStatus>
<code>CREAT</code>
<codeName>NET CREAT State</codeName>
</publicIpInstanceStatus>
<publicIpInstanceOperation>
<code>NULL</code>
<codeName>NET NULL OP</codeName>
</publicIpInstanceOperation>
<publicIpKindType>
<code>GEN</code>
<codeName>General</codeName>
</publicIpKindType>
<serverInstanceAssociatedWithPublicIp/>
<zone>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>KR-1 zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</publicIpInstanceList>
<publicIpInstanceList>
<publicIpInstanceNo>397030</publicIpInstanceNo>
<publicIp>192.168.60.117</publicIp>
<publicIpDescription>test</publicIpDescription>
<createDate>2018-02-20T21:32:24+0900</createDate>
<publicIpInstanceStatusName>created</publicIpInstanceStatusName>
<publicIpInstanceStatus>
<code>CREAT</code>
<codeName>NET CREAT State</codeName>
</publicIpInstanceStatus>
<publicIpInstanceOperation>
<code>NULL</code>
<codeName>NET NULL OP</codeName>
</publicIpInstanceOperation>
<publicIpKindType>
<code>GEN</code>
<codeName>General</codeName>
</publicIpKindType>
<serverInstanceAssociatedWithPublicIp/>
<zone>
<zoneNo>2</zoneNo>
<zoneName>KR-1</zoneName>
<zoneCode>KR-1</zoneCode>
<zoneDescription>KR-1 zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
</publicIpInstanceList>
</getPublicIpInstanceListResponse>
이 문서가 도움이 되었습니까?