Docs
api
Private Network(UVPC)
CreateNATGWPolicy

Add NAT Gateway Port Forwarding Rule - CreateNATGWPolicy

Overview

Add NAT Gateway Port Forwarding Rule

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateNATGWPolicy.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 be filled in. Please refer to the GetProjectList interface.No
NATGWIdstringNAT Gateway IdYes
ProtocolstringProtocol type. Enumerated values are: TCP, UDPYes
SrcEIPIdstringSource IP. Fill in the corresponding EIP Id.Yes
SrcPortstringSource port. You can fill in a fixed port or a port range. The supported port range is 1-65535.Yes
DstIPstringTarget IP. Fill in the corresponding target IP address.Yes
DstPortstringDestination port. You can fill in a fixed port or a port range. The supported port range is 1-65535.Yes
PolicyNamestringForwarding policy name. 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
PolicyIdstringPolicy Id assigned at creationYes

Example

Request Example

https://api.ucloud-global.com/?Action=CreateNATGWPolicy
&Region=xxx
&ProjectId=xxx
&NATGWId=voSmtyDG
&Protocol=TCP
&SrcEIPId=MXCFGaVb
&SrcPort=NIQlfARc
&DstIp=WPpinHDz
&DstPort=NjuwdUIK
&PolicyName=MGnDgSGN

Response Example

{
  "Action": "CreateNATGWPolicyResponse",
  "PolicyId": "FXizRyCb",
  "RetCode": 0
}