docs
api
Private Network(UVPC)
AddSnatRule

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 NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is AddSnatRule.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
NATGWIdstringThe ID of the NAT GatewayYes
SourceIpstringPrivate IP address needed for external network access, for example, 10.9.7.xxYes
SnatIpstringThe IP address of EIP, for example, 106.75.xx.xxYes
NamestringSNAT rule name, default is "Exit Rule"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

Example

Request Example

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

Response Example

{
  "Action": "AddSnatRuleResponse",
  "RetCode": 0,
  "SnatId": "QORDRLTL"
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved