Query SNAT entries using DescribeSnatTableEntries - ENS

Queries source network address translation (SNAT) entries.

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:DescribeSnatTableEntries

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NatGatewayId	string	Yes	The ID of the Network Address Translation (NAT) gateway.	nat-5tawjw5j7sgd2deujxuk0****
SnatEntryId	string	No	The ID of the SNAT entry.	snat-5tfjp36fsrb36zs36faj0****
SnatIp	string	No	The elastic IP address (EIP) specified in the SNAT entry.	58.XXXX.XXX.29
SourceCIDR	string	No	The source CIDR block specified in the SNAT entry.	10.1.0.50/32
SnatEntryName	string	No	The name of the SNAT entry.	test0
SnatIps	array	No	The information about the EIP specified in the SNAT entry.
	string	No	The information about the EIP specified in the SNAT entry.	58.XXXX.XXX.30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. The maximum value is 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The number of SNAT entries that are returned.	7
PageSize	integer	The number of entries per page.	10
SnatTableEntries	array<object>	The details of the SNAT entries.
	object	The details of the SNAT entry.
NatGatewayId	string	The ID of the NAT gateway.	nat-5t7nh1cfm6kxiszlttr38****
SnatEntryId	string	The ID of the SNAT entry.	snat-5tfjp3537mi6iokl59g5c****
SnatIp	string	The EIP specified in the SNAT entry.	120.XXX.XXX.71
SourceCIDR	string	The source CIDR block specified in the SNAT entry.	10.0.0.13/32
SnatEntryName	string	The name of the SNAT entry.	test0
Status	string	The status of the SNAT entry. Valid values: Pending: The SNAT entry is being created or modified. Available: The SNAT entry is available. Deleting: The SNAT entry is being deleted.	Available
StandbySnatIp	string	The secondary EIP. Multiple EIPs are separated by commas (,).	101.XXX.XXX.7
StandbyStatus	string	The status of the secondary EIP. Valid values: Running Stopping Stopped Starting	Stopped
IdleTimeout	integer	The timeout period for idle connections. Valid values: 1 to 86400. Unit: seconds.	900
IspAffinity	boolean	Whether to enable operator affinity. Value taking: false:Do not open. true:Open.	true
EipAffinity	boolean	Specifies whether to enable EIP affinity. Valid values: 0: no 1: yes Description** After you enable EIP affinity, if multiple EIPs are associated with an SNAT entry, each client uses one EIP to access the Internet. If EIP affinity is disabled, each client uses a random EIP to access the Internet.	false

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 7,
  "PageSize": 10,
  "SnatTableEntries": [
    {
      "NatGatewayId": "nat-5t7nh1cfm6kxiszlttr38****",
      "SnatEntryId": "snat-5tfjp3537mi6iokl59g5c****",
      "SnatIp": "120.XXX.XXX.71",
      "SourceCIDR": "10.0.0.13/32",
      "SnatEntryName": "test0",
      "Status": "Available",
      "StandbySnatIp": "101.XXX.XXX.7",
      "StandbyStatus": "Stopped",
      "IdleTimeout": 900,
      "IspAffinity": true,
      "EipAffinity": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	InvalidParameter.NatNotFound	The specified Nat is not found.	The specified parameter Nat does not exist.
400	ens.interface.error	Failed to call API.
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.