DescribeSnatTableEntries - ENS - Alibaba Cloud Documentation Center

Queries source network address translation (SNAT) entries.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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
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 parameters

Parameter	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	object []	Details of SNAT entries.
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

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	ens.interface.error	An error occurred while call the API.
400	InvalidParameter.NatNotFound	The specified Nat is not found.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-11-16

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Output Parameters	The response structure of the API has changed.

2023-10-19

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Output Parameters	The response structure of the API has changed.

2023-07-18

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
Output Parameters	The response structure of the API has changed.