getNatGatewayInstanceList
    • PDF

    getNatGatewayInstanceList

    • PDF

    기사 요약

    VPC 환경에서 이용 가능합니다.

    개요

    NAT Gateway 인스턴스 리스트를 조회합니다.

    요청

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    regionCodeNoString- 리전 코드
    NAT Gateway 인스턴스 리스트가 조회될 리전(Region) 결정 가능
    regionCode는 getRegionList 액션을 통해 획득 가능
    Default : getRegionList 조회 결과의 첫 번째 리전을 선택
    zoneCodeNoString- ZONE 코드
    NAT Gateway 인스턴스 리스트가 조회될 존(zone) 결정 가능
    zoneCode는 getZoneList 액션을 통해 획득 가능
    natGatewayInstanceNoList.NNoList<String>- NAT Gateway 인스턴스 번호 리스트
    NAT Gateway 인스턴스 번호로 필터링하여 검색 가능
    natGatewayInstanceNo는 getNatGatewayInstanceList 액션을 통해 획득 가능
    ex) natGatewayInstanceNoList.1=1234&natGatewayInstanceNoList.2=2345
    publicIpNoString- 공인 IP 주소
    NAT Gateway에 할당된 공인 IP 주소로 필터링하여 검색 가능
    vpcNameNoString- VPC 이름
    VPC 이름으로 필터링하여 검색 가능
    natGatewayNameNoString- NAT Gateway 이름
    NAT Gateway 이름으로 필터링하여 검색 가능
    natGatewayInstanceStatusCodeNoString- NAT Gateway 인스턴스 상태 코드
    NAT Gateway 인스턴스의 상태 코드로 필터링하여 검색 가능
    Options : INIT | RUN | TERMTING
    pageNoNoInteger- 페이징된 결과의 페이지 번호
    결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
    pageSizeConditionalInteger- 페이징 시 보여줄 각 페이지 사이즈
    결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
    pageNo 입력시 반드시 입력함
    responseFormatTypeNoString- 응답 결과의 포맷 타입
    Options : xml | json
    Default : xml
    subnetNameNoString- Subnet 이름
    privateIpNoString- 사설 IP
    natGatewayTypeCodeNoCommonCode- NAT Gateway 유형
    PRVT (Private NAT Gateway)
    PBLIP (Public NAT Gateway)
    subnetNoNoString- Subnet 번호

    응답

    응답 바디

    예시

    요청 예시

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

    응답 예시

    <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>2022-08-06T11:47:40+0900</createDate>
          <natGatewayDescription></natGatewayDescription>
          <zoneCode>KR-1</zoneCode>
            <natGatewayType>
            <code>PBLIP</code>
            <codeName>Public</codeName>
          </natGatewayType>
          <subnetName>v-kr1-pub-natgw-***</subnetName>
          <subnetNo>***28</subnetNo>
          <privateIp>10.0.***.***</privateIp>
          <publicIpInstanceNo>***25</publicIpInstanceNo>
        </natGatewayInstance>
      </natGatewayInstanceList>
    </getNatGatewayInstanceListResponse>
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.