VPC 환경에서 이용 가능합니다.
개요
NAT Gateway 인스턴스 리스트를 조회합니다.
요청
요청 파라미터
파라미터명 |
필수 여부 |
타입 |
제약 사항 |
설명 |
regionCode |
No |
String |
|
리전 코드- NAT Gateway 인스턴스 리스트가 조회될 리전(Region) 결정 가능
- regionCode는 getRegionList 액션을 통해 획득 가능
- Default: getRegionList 조회 결과의 첫 번째 리전을 선택
|
zoneCode |
No |
String |
|
ZONE 코드- NAT Gateway 인스턴스 리스트가 조회될 존(zone) 결정 가능
- zoneCode는 getZoneList 액션을 통해 획득 가능
|
natGatewayInstanceNoList.N |
No |
List<String> |
|
NAT Gateway 인스턴스 번호 리스트- NAT Gateway 인스턴스 번호로 필터링하여 검색 가능
- natGatewayInstanceNo는 getNatGatewayInstanceList 액션을 통해 획득 가능
- ex) --natGatewayInstanceNoList 1234 2345
|
publicIp |
No |
String |
|
공인 IP 주소- NAT Gateway에 할당된 공인 IP 주소로 필터링하여 검색 가능
|
vpcName |
No |
String |
|
VPC 이름 |
natGatewayName |
No |
String |
|
NAT Gateway 이름- NAT Gateway 이름으로 필터링하여 검색 가능
|
natGatewayInstanceStatusCode |
No |
String |
|
NAT Gateway 인스턴스 상태 코드- NAT Gateway 인스턴스의 상태 코드로 필터링하여 검색 가능
- Options: INIT | RUN | SET | TERMTING
|
pageNo |
No |
Integer |
|
페이징된 결과의 페이지 번호- 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
|
pageSize |
Conditional |
Integer |
|
페이징 시 보여줄 각 페이지 사이즈- 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
- pageNo 입력시 반드시 입력 필요
|
output |
No |
String |
|
응답 결과의 포맷 타입- Options: xml | json
- Default: json
|
natGatewayTypeCode |
No |
String |
|
NAT Gateway 유형 |
subnetName |
No |
String |
|
Subnet 이름 |
subnetNo |
No |
String |
|
Subnet 번호 |
privateIp |
No |
String |
|
사설 IP 주소 |
publicIpInstanceNo |
No |
String |
|
Public IP 인스턴스 번호 |
응답
응답 데이터 타입
NatGatewayInstanceList extends CommonResponse |
private Integer totalRows; |
private List<NatGatewayInstance> natGatewayInstanceList |
NatGatewayInstance |
private String vpcNo; |
private String vpcName; |
private String natGatewayInstanceNo; |
private String natGatewayName; |
private String publicIp; |
private CommonCode natGatewayInstanceStatus; |
private String natGatewayInstanceStatusName; |
private CommonCode natGatewayInstanceOperation; |
private Date createDate; |
private String natGatewayDescription; |
private String zoneCode; |
private CommonCode natGatewayType; |
private String subnetName; |
private String subnetNo; |
private String privateIp; |
private String publicIpInstanceNo; |
private List<NatGatewayIp> natGatewayIpList; |
NatGatewayIp |
private String type; |
private String privateIp; |
private String publicIp; |
private String publicIpInstanceNo; |
예시
요청 예시
ncloud vpc getNatGatewayInstanceList --regionCode KR --zoneCode KR-1 --natGatewayInstanceNoList ***9734 --publicIp ***.***.109.101 --vpcName test-vpc --natGatewayName test-*** --natGatewayInstanceStatusCode RUN --natGatewayTypeCode PBLIP
응답 예시
<getNatGatewayInstanceListResponse>
<requestId>09b86d75-4a0b-4148-ab7f-5412d15bcb22</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<natGatewayInstanceList>
<natGatewayInstance>
<vpcNo>***36</vpcNo>
<vpcName>normal-***</vpcName>
<natGatewayInstanceNo>*****9288</natGatewayInstanceNo>
<natGatewayName>public-***</natGatewayName>
<publicIp>***.***.153.178</publicIp>
<natGatewayInstanceStatus>
<code>RUN</code>
<codeName>RUN 상태</codeName>
</natGatewayInstanceStatus>
<natGatewayInstanceStatusName>Running</natGatewayInstanceStatusName>
<natGatewayInstanceOperation>
<code>NULL</code>
<codeName>NULL OP</codeName>
</natGatewayInstanceOperation>
<createDate>2025-04-25T14:19:32+0900</createDate>
<natGatewayDescription>description</natGatewayDescription>
<zoneCode>KR-1</zoneCode>
<natGatewayType>
<code>PBLIP</code>
<codeName>공인</codeName>
</natGatewayType>
<subnetName>public-***</subnetName>
<subnetNo>***29</subnetNo>
<privateIp>10.0.1.6</privateIp>
<publicIpInstanceNo>****290</publicIpInstanceNo>
<natGatewayIpList>
<natGatewayIp>
<type>PRIMARY</type>
<privateIp>10.0.1.6</privateIp>
<publicIp>***.***.153.178</publicIp>
<publicIpInstanceNo>****290</publicIpInstanceNo>
</natGatewayIp>
<natGatewayIp>
<type>SECONDARY</type>
<privateIp>10.0.1.7</privateIp>
<publicIp>***.***.109.24</publicIp>
<publicIpInstanceNo>****805</publicIpInstanceNo>
</natGatewayIp>
</natGatewayIpList>
</natGatewayInstance>
</natGatewayInstanceList>
</getNatGatewayInstanceListResponse>