Modify SNAT Entries with EIP Affinity for Multi-EIP Routing - ENS

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

ens:ModifySnatEntry

update

*NatGatewaySnatEntry

acs:ens::{#accountId}:natgatewaysnatentry/{#SnatEntryId}

None

Request parameters

Parameter	Type	Required	Description	Example
SnatEntryId	string	Yes	The ID of the SNAT entry.	snat-5tfjp36fsrb36zs36faj0****
SnatEntryName	string	No	The name of the SNAT entry. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	test0
IspAffinity	boolean	No	Specifies whether to enable carrier affinity.	true
EipAffinity	boolean	No	Specifies whether to enable IP affinity. Default value: true. Valid values: false true Note Description After you enable IP affinity, if multiple EIPs are associated with an SNAT entry, one client uses the same EIP to for communication. If IP affinity is disabled, the client uses a random EIP for communication.	false
SnatIp	string	No	Separate multiple EIPs in the SNAT entry with commas (,).	120.XXX.XXX.71

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	125B04C7-3D0D-4245-AF96-14E3758E3F06

Examples

Success response

JSON format

{
  "RequestId": "125B04C7-3D0D-4245-AF96-14E3758E3F06"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Missing%s	You must specify the parameter %s.
400	Invalid%s	The specified parameter %s is invalid.
400	InvalidSnatEntryId.NotFound	The specified snatEntry is not found.	The specified SNAT does not exist. Check whether the input parameters are correct.
400	ens.interface.error	Failed to call API.
400	IncorretSnatEntryStatus	Snat entry status blocked this operation.	Snat status is not correct, please check Snat status.
400	Forbidden.SnatIpUsedInDnat	The snatIp is already in use in the DNAT rule.	The snatIp is already in use in the DNAT rule. Please check.
400	InvalidSnatIp.NotFound	Specified SnatIp does not found on the NAT Gateway.	The public IP address is not in the NAT Gateway.
400	QuotaExceeded.SnatIp	Public ip number exceeds quota.	The number of public IP addresses exceeds the limit.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.