getNatGatewayInstanceList

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

사용자가 지정한 조건에 따라 NAT Gateway 인스턴스 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET, POST	/getNatGatewayInstanceList

요청 헤더

VPC API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 VPC 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Optional	Network ACL 인스턴스 목록을 조회하려는 리전 코드 조회 결과의 첫 번째 리전(기본값) getRegionList를 통해 확인
`zoneCode`	String	Optional	NAT Gateway 인스턴스 목록을 조회하려는 존 코드 getZoneList를 통해 확인
`natGatewayInstanceNoList.N`	List<String>	Optional	NAT Gateway 인스턴스 번호로 조회 `natGatewayInstanceNo`는 getNatGatewayInstanceList를 통해 확인 <예시> natGatewayInstanceNoList.1=1234&natGatewayInstanceNoList.2=2345
`publicIp`	String	Optional	NAT Gateway에 할당된 공인 IP 주소로 조회
`vpcName`	String	Optional	VPC 이름으로 조회
`natGatewayName`	String	Optional	NAT Gateway 이름으로 조회
`natGatewayInstanceStatusCode`	String	Optional	NAT Gateway 인스턴스 상태 코드로 조회 `INIT` \| `RUN` \| `TERMTING`
`pageNo`	Integer	Optional	페이징된 결과의 페이지 번호 `pageNo`, `pageSize`를 이용하여 결과값을 페이징 처리
`pageSize`	Integer	Conditional	페이징 시 보여줄 각 페이지 크기 `pageNo` 입력 시 필수 `pageNo`, `pageSize`를 이용하여 결과값을 페이징 처리
`responseFormatType`	String	Optional	응답 결과의 형식 `xml` (기본값) \| `json`
`subnetName`	String	Optional	Subnet 이름으로 조회
`privateIp`	String	Optional	사설 IP 주소로 조회
`natGatewayTypeCode`	CommonCode	Optional	NAT Gateway 유형으로 조회 `PRVT` \| `PBLIP` `PRVT`: Private NAT Gateway `PBLIP`: Public NAT Gateway
`subnetNo`	String	Optional	Subnet 번호로 조회

요청 예시

요청 예시는 다음과 같습니다.

curl --location 'https://ncloud.apigw.gov-ntruss.com/vpc/v2/getNatGatewayInstanceList
?regionCode=KR
&zoneCode=KR-1
&natGatewayInstanceNoList.1=***9734
&publicIp=***.***.109.101
&vpcName=test-vpc
&natGatewayName=test-***
&natGatewayInstanceStatusCode=RUN
&natGatewayTypeCode=PBLIP'
--header 'x-ncp-apigw-timestamp: {Timestamp}'     
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 NatGatewayInstanceList를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

<getNatGatewayInstanceListResponse>
  <requestId>7d68eb6c-6015-45d1-8711-e5e65d3704c6</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <natGatewayInstanceList>
    <natGatewayInstance>
      <vpcNo>***36</vpcNo>
      <vpcName>test-vpc</vpcName>
      <natGatewayInstanceNo>***9734</natGatewayInstanceNo>
      <natGatewayName>test-***</natGatewayName>
      <publicIp>***.***.109.101</publicIp>
      <natGatewayInstanceStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Running</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
         <code>NULL</code>
         <codeName>NULL OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2023-04-18T15:13:27+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>