Add outbound rules (SNAT rules) - AddSnatRule

Overview

For a NAT gateway bound with multiple EIPs, you can map a cloud host in a subnet to a specific EIP. Once the rule takes effect, this cloud host can access the internet through this specific EIP.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `AddSnatRule`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
NATGWId	string	The ID of the NAT Gateway	Yes
SourceIp	string	Private IP address needed for external network access, for example, 10.9.7.xx	Yes
SnatIp	string	The IP address of EIP, for example, 106.75.xx.xx	Yes
Name	string	SNAT rule name, default is "Exit Rule"	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No

Example

Request Example

https://api.ucloud-global.com/?Action=AddSnatRule
&NATGWId=cn-zj
&SourceIp=dIVNpaqc
&SnatEip=iBIYwnZQ
&Name=WhwIqVvZ

Response Example

{
  "Action": "AddSnatRuleResponse",
  "RetCode": 0,
  "SnatId": "QORDRLTL"
}

Index AddVPCNetwork