DescribeNatFirewallList - - Alibaba Cloud Documentation Center

Queries details of NAT firewalls.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cloudfirewall:DescribeNatFirewallList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the response. Valid values: zh (default) en	zh
PageNo	long	No	The page number.	1
PageSize	long	No	The number of entries per page. Default value: 10.**** Maximum value: 50.	10
ProxyId	string	No	The ID of the NAT firewall.	proxy-nat97a******
ProxyName	string	No	The name of the NAT firewall. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (_). The name cannot start with an underscore.	proxy-******
RegionNo	string	No	The region ID of the virtual private cloud (VPC).	cn-hangzhou
VpcId	string	No	The ID of the VPC.	vpc-8vbwbo90rq0anm6t****
NatGatewayId	string	No	The ID of the NAT gateway.	nat-bp123456g******
Status	string	No	The status of the NAT firewall. Valid values: configuring deleting normal abnormal opening closing closed	normal
MemberUid	long	No	The UID of the member that is managed by your Alibaba Cloud account.	147783******

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of NAT firewalls.	10
RequestId	string	The request ID.	15FCCC52-1E23-57AE-B5EF-3E00A3******
NatFirewallList	array<object>	The NAT firewalls.
Data	object
MemberUid	long	The UID of the member in Cloud Firewall.	19106481******
AliUid	long	The UID of the Alibaba Cloud account. Note The value of this parameter indicates the management account to which the member is added.	19106481******
ProxyId	string	The ID of the NAT firewall.	proxy-nat30******
ProxyName	string	The name of the NAT firewall.	proxy-******
ProxyStatus	string	The status of the NAT firewall. Valid values: configuring deleting normal abnormal opening closing closed	normal
RegionId	string	The region ID of your Cloud Firewall. Note For more information about the supported regions of Cloud Firewall, see Supported regions.	cn-qingdao
NatGatewayId	string	The ID of the NAT gateway.	ngw-uf6tnblxip4qcxg******
NatGatewayName	string	The name of the NAT gateway.	nat-******
VpcId	string	The ID of the VPC.	vpc-2ze26ya******
VpcName	string	The name of the VPC.	vpc-******
ErrorDetail	string	The cause of the error.	Create Failed.
StrictMode	integer	Indicates whether the strict mode is enabled. Valid values: 1, which specifies yes, and 0, which specifies no.	0
NatRouteEntryList	array<object>	The default route entries of the NAT gateway.
NatRouteEntryList	object
RouteTableId	string	The route table to which the default route of the NAT gateway belongs.	vtb-bp18o0gb******
NextHopId	string	The next hop of the original NAT gateway.	ngw-2ze0s284r9atg5******
NextHopType	string	The network type of the next hop. The value is fixed as NatGateway.	NatGateway
DestinationCidr	string	The destination CIDR block of the default route.	0.0.0.0/0

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******\n",
  "NatFirewallList": [
    {
      "MemberUid": 0,
      "AliUid": 0,
      "ProxyId": "proxy-nat30******",
      "ProxyName": "proxy-******",
      "ProxyStatus": "normal",
      "RegionId": "cn-qingdao",
      "NatGatewayId": "ngw-uf6tnblxip4qcxg******",
      "NatGatewayName": "nat-******",
      "VpcId": "vpc-2ze26ya******",
      "VpcName": "vpc-******",
      "ErrorDetail": "Create Failed.",
      "StrictMode": 0,
      "NatRouteEntryList": [
        {
          "RouteTableId": "vtb-bp18o0gb******",
          "NextHopId": "ngw-2ze0s284r9atg5******",
          "NextHopType": "NatGateway",
          "DestinationCidr": "0.0.0.0/0"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorPageNo	Either page number or page size is invalid.	Either page number or page size is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorNatGatewayNotAvailable	Nat gateway not available.	The NAT gateway status is unavailable and cannot be operated.
400	ErrorDnatNotSupport	NAT firewall does not support DAT entries.	NAT firewall does not support DNAT.
400	ErrorProxySnatIpEmpty	SNAT entry is empty.	SNAT entry is empty.

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

Change history

Change time	Summary of changes	Operation
2024-05-27	The response structure of the API has changed	View Change Details