createNatGatewayInstance

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

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

요청

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

메서드	URI
GET, POST	/createNatGatewayInstance

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`regionCode`	String	Optional	Network ACL 인스턴스를 생성하려는 리전 코드 조회 결과의 첫 번째 리전(기본값) getRegionList를 통해 확인
`zoneCode`	String	Required	NAT Gateway 인스턴스를 생성하려는 존 `zoneCode`는 getZoneList를 통해 확인
`vpcNo`	String	Required	NAT Gateway 인스턴스를 생성하려는 VPC 번호 getVpcList를 통해 확인
`natGatewayName`	String	Optional	생성하려는 NAT Gateway 이름 네이버 클라우드 플랫폼에서 자동으로 부여(기본값) 3~30자로 영문 소문자, 숫자, 특수 문자 '-'를 허용하며 영문자로 시작해서 영문자 또는 숫자로 끝나야 함
`natGatewayDescription`	String	Optional	생성하려는 NAT Gateway에 대한 설명 0~1000 Bytes
`responseFormatType`	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를 참조해 주십시오.

응답 상태 코드

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

응답 예시

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

<createNatGatewayInstanceResponse>
  <requestId>4475d78c-4c27-4404-807d-7b0b645bb127</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>INIT</code>
            <codeName>init</codeName>
        </natGatewayInstanceStatus>
        <natGatewayInstanceStatusName>Creating</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>
</createNatGatewayInstanceResponse>