VPC 환경에서 이용 가능합니다.
개요
NAT Gateway 인스턴스를 생성합니다.
요청
요청 파라미터
| 파라미터명 |
필수 여부 |
타입 |
제약 사항 |
설명 |
| regionCode |
No |
String |
|
리전 코드- NAT Gateway 인스턴스가 생성될 리전(Region) 결정 가능
- regionCode는 getRegionList 액션을 통해 획득 가능
- Default: getRegionList 조회 결과의 첫 번째 리전을 선택
|
| zoneCode |
Yes |
String |
|
ZONE 코드- NAT Gateway 인스턴스가 생성될 존(zone) 결정
- zoneCode는 getZoneList 액션을 통해 획득 가능
|
| vpcNo |
Yes |
String |
|
VPC 번호- NAT Gateway 인스턴스가 생성될 VPC 결정
- vpcNo는 getVpcList 액션을 통해 획득 가능
|
| natGatewayName |
No |
String |
- Min: 3, Max: 30
- 소문자, 숫자, "-"의 특수문자만 허용하며 알파벳 문자로 시작해야 함
- 영어 또는 숫자로 끝나야 함
|
생성할 NAT Gateway 이름- Default: NAVER Cloud Platform이 자동으로 부여
|
| natGatewayDescription |
No |
String |
Min: 0, Max: 1000 Bytes |
생성할 NAT Gateway에 대한 설명 |
| responseFormatType |
No |
String |
|
응답 결과의 포맷 타입- Options: xml | json
- Default: xml
|
| publicIpInstanceNo |
No |
String |
|
Public IP Instance 번호- Subnet이 PRIVATE(subnetTypeCode) 타입인경우 무시
- Subnet이 PUBLIC일 경우 publicIpInstanceNo가 NULL이면 자동생성, NOT-NULL 이면 할당
|
| privateIp |
No |
String |
|
사설 IP- Subnet이 PUBLIC 이면 무시
- Subnet이 PUBLIC일 경우 NULL이면 자동할당, NOT-NULL이면 해당 IP로 생성
|
| subnetNo |
No |
String |
|
NATGW 타입의 SubnetNo- NULL이면 PUBLIC 타입의 NATGW Subnet 생성
- NOT-NULL이면 NATGW Subnet의 subnetTypeCode에 따라 NATGateway 생성
|
응답
응답 데이터 타입
| NatGatewayInstanceList extends CommonResponse |
| private Integer totalRows; |
| private List<NatGatewayInstance> natGatewayInstanceList |
| NatGatewayInstance |
| private String vpcNo; |
| private String vpcName; |
| private String natGatewayInstanceNo; |
| private String natGatewayName; |
| private String publicIp; |
| private CommonCode natGatewayInstanceStatus; |
| private String natGatewayInstanceStatusName; |
| private CommonCode natGatewayInstanceOperation; |
| private Date createDate; |
| private String natGatewayDescription; |
| private String zoneCode; |
| private CommonCode natGatewayType; |
| private String subnetName; |
| private String subnetNo; |
| private String privateIp; |
| private String publicIpInstanceNo; |
| private List<NatGatewayIp> natGatewayIpList; |
| NatGatewayIp |
| private String type; |
| private String privateIp; |
| private String publicIp; |
| private String publicIpInstanceNo; |
예시
요청 예시
ncloud vpc createNatGatewayInstance --regionCode KR --zoneCode KR-1 --vpcNo ***04 --natGatewayName test-*** --subnetNo ***28 --publicIpInstanceNo ***25
응답 예시
<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>