Docs
api
Private Network(UVPC)
CreateNATGW

Create NAT Gateway - CreateNATGW

Overview

Create NAT Gateway

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateNATGW.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject Id. If not filled in, the default project is used. Sub-accounts must fill in. Please refer to the GetProjectList interface.No
NATGWNamestringNAT Gateway NameYes
EIPIds.NstringEIPId bound to the NAT gatewayYes
FirewallIdstringThe Firewall Id bound to the NAT GatewayYes
SubnetworkIds.NstringThe subnet Id bound to the NAT gateway, default is empty.No
VPCIdstringThe VPC Id to which the NAT Gateway belongs. Default is Default VPC IdNo
IfOpenintWhitelist switch flag. 0 indicates off, 1 indicates on. The default is 0.No
TagstringBusiness Group. Default is empty.No
RemarkstringNote. Default is empty.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
NATGWIdstringApplied NATGateWay IdNo

Example

Request Example

https://api.ucloud-global.com/?Action=CreateNATGW
&Region=xxx
&ProjectId=xxx
&NATGWName=yNgsbTKP
&SubnetworkIds.n=YLsLksid
&EIPIds.n=hrjFtZYb
&FirewallId=cuUhZpkK
&VPCId=lunRAEbp
&IfOpen=0
&Tag=xwJQsEdL
&Remark=GREoMkdj

Response Example

{
  "Action": "CreateNATGWResponse",
  "NATGWId": "FPvaAtuP",
  "RetCode": 0
}