Smart Access Gateway:AddSnatEntry - Smart Access Gateway

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:AddSnatEntry

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the SAG instance is deployed.	cn-hangzhou
SmartAGId	string	Yes	The ID of the SAG instance.	sag-jf5w9a8k5mhi5h****
CidrBlock	string	Yes	The destination CIDR block.	192.168.1.0/24
SnatIp	string	Yes	The public IP address.	11.0.XX.XX

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	56BF6C79-C77D-41A0-86DD-A4B156E784EA
InstanceId	string	The ID of the SNAT instance.	snat-m2obgkt5ya1puz****

Examples

Success response

JSON format

{
  "RequestId": "56BF6C79-C77D-41A0-86DD-A4B156E784EA",
  "InstanceId": "snat-m2obgkt5ya1puz****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.
400	SNAT.CidrConfigExist	The specified SNAT CIDR block already exists.	The specified SNAT CIDR block already exists.
400	SNAT.AmountLimit	The maximum number of SNAT entries is exceeded.	The maximum number of SNAT entries is exceeded.
400	SNAT.SnatDnatIpConflict	The SNAT destination IP address is the same as the DNAT IP address.	The SNAT destination IP address is the same as the DNAT IP address.
400	SNAT.InvalidCidr	The specified SNAT CIDR block is invalid.	The specified SNAT CIDR block is invalid.
400	SmartAccessGatewayInArrears	The specified Smart Access Gateway has expired.	The specified Smart Access Gateway has expired.
400	SmartAccessGatewayNotActivated	The specified Smart Access Gateway has not been activated.	The specified SAG instance is inactive. You must activate the instance first.
400	SNAT.InvalidIp	The specified SNAT destination IP is invalid.	The specified SNAT destination IP is invalid.
403	FeatureNotSupport	The current edition of the smart access gateway does not support this feature.	The current version of Smart Access Gateway does not support this feature.
403	FeatureNotSupportForStandBySmartAG	The current edition of the standby smart access gateway does not support this feature.	The current version of Smart Access Gateway does not support this feature.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.