createNatGatewayInstance

Prev Next

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

NAT Gateway 인스턴스를 생성합니다.

요청

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

메서드 URI
GET | POST /vpc/v2/createNatGatewayInstance
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional Network ACL 인스턴스를 생성하려는 리전 코드
  • 조회 결과의 첫 번째 리전(기본값)
  • getRegionList 참조
zoneCode String Required NAT Gateway 인스턴스를 생성하려는 존
vpcNo String Required NAT Gateway 인스턴스를 생성하려는 VPC 번호
natGatewayName String Optional 생성하려는 NAT Gateway 이름
  • 네이버 클라우드 플랫폼에서 자동으로 부여(기본값)
  • 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 3~30자 이내로 입력
  • 문자열은 영문자로 시작해서 영문자 또는 숫자로 끝나야 함
natGatewayDescription String Optional 생성하려는 NAT Gateway에 대한 설명(Byte)
  • 0~1000
output String Optional 응답 결과의 형식
  • xml | json(기본값)
publicIpInstanceNo String Optional 공인 IP Instance 번호
  • Subnet이 PRIVATE 타입인 경우 이 파라미터는 무시됨
  • Subnet이 PUBLIC 타입인 경우
    • publicIpInstanceNo가 NULL이면 공인 IP가 자동으로 생성됨
    • publicIpInstanceNo가 NOT-NULL이면 지정된 공인 IP가 할당됨
privateIp String Optional 사설 IP 주소
  • privateIp가 NULL이면 사설 IP가 자동으로 할당됨
  • privateIp가 NOT-NULL이면 지정된 사설 IP가 할당됨
subnetNo String Optional NAT Gateway 인스턴스를 생성하려는 Subnet 번호
  • subnetNo가 NULL이면 PUBLIC 타입의 NAT Gateway Subnet에 생성됨
  • subnetNo가 NOT-NULL이면 NAT Gateway Subnet의 subnetTypeCode에 따라 NAT Gateway가 생성됨

요청 예시

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

curl --location 'https://ncloud.apigw.gov-ntruss.com/vpc/v2/createNatGatewayInstance
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***04
&natGatewayName=test-***
&subnetNo=***28
&publicIpInstanceNo=***25' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

응답 상태 코드

VPC API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 VPC API 응답 상태 코드를 참조해 주십시오.

응답 예시

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

<createNatGatewayInstanceResponse>
  <requestId>fae73c15-7b8d-4c09-80c2-21d46a327c4d</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></publicIp>
      <natGatewayInstanceStatus>
        <code>INIT</code>
        <codeName>INIT 상태</codeName>
      </natGatewayInstanceStatus>
      <natGatewayInstanceStatusName>Creating</natGatewayInstanceStatusName>
      <natGatewayInstanceOperation>
        <code>CREAT</code>
        <codeName>CREAT OP</codeName>
      </natGatewayInstanceOperation>
      <createDate>2025-05-08T18:38:25+0900</createDate>
      <natGatewayDescription></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></publicIpInstanceNo>
      <natGatewayIpList>
        <natGatewayIp>
          <type>PRIMARY</type>
          <privateIp>10.0.1.8</privateIp>
          <publicIp></publicIp>
          <publicIpInstanceNo></publicIpInstanceNo>
        </natGatewayIp>
      </natGatewayIpList>
    </natGatewayInstance>
  </natGatewayInstanceList>
</createNatGatewayInstanceResponse>