getNatGatewayInstanceList

개요

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.1=1234&natGatewayInstanceNoList.2=2345
publicIp No String 공인 IP 주소
NAT Gateway에 할당된 공인 IP 주소로 필터링하여 검색할 수 있습니다.
vpcName No String VPC 이름
VPC 이름으로 필터링하여 검색할 수 있습니다.
natGatewayName No String NAT Gateway 이름
NAT Gateway 이름으로 필터링하여 검색할 수 있습니다.
natGatewayInstanceStatusCode No String NAT Gateway 인스턴스 상태 코드
NAT Gateway 인스턴스의 상태 코드로 필터링하여 검색할 수 있습니다.
Options : INIT | RUN | TERMTING
pageNo No Integer 페이징된 결과의 페이지 번호
결과값을 pageNo, pageSize를 이용하여 페이징 처리를 할 수 있습니다.
pageSize Conditional Integer 페이징 시 보여줄 각 페이지 사이즈
결과값을 pageNo, pageSize를 이용하여 페이징 처리를 할 수 있습니다.
pageNo 입력시 반드시 입력합니다.
responseFormatType No String 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 바디

예시

요청 예시

GET {API_URL}/vpc/v2/getNatGatewayInstanceList
?regionCode=KR
&zoneCode=KR-1
&natGatewayInstanceNoList.1=***9734
&publicIp=***.***.109.101
&vpcName=test-vpc
&natGatewayName=test-***
&natGatewayInstanceStatusCode=RUN

응답 예시

<getNatGatewayInstanceListResponse>
  <requestId>7d68eb6c-6015-45d1-8711-e5e65d3704c6</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***04</vpcNo>
      <vpcName>test-***</vpcName>
      <natGatewayInstanceNo>***9734</natGatewayInstanceNo>
      <natGatewayName>test-***</natGatewayName>
      <publicIp>***.***.109.101</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>운영중</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2020-08-06T11:47:40+0900</createDate>
      <natGatewayDescription></natGatewayDescription>
      <zoneCode>KR-1</zoneCode>
    </natGatewayInstance>
  </natGatewayInstanceList>
</getNatGatewayInstanceListResponse>