DescribeNatFirewallList - Cloud Firewall - Alibaba Cloud Documentation Center

Queries NAT firewall details.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response message. Valid values: zh (default): Chinese en: English	zh
Lang	string	No	The language of the response message. Valid values: zh (default): Chinese en: English	zh
PageNo	integer	No	The page number.	1
PageSize	integer	No	The number of NAT firewalls to return on each page for a paged query. The default value is 10. The maximum value is 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. It can contain letters, digits, and underscores (_). It cannot start with an underscore (_).	nat-防火墙测试
RegionNo	string	No	The region ID of the VPC. Note For more information about the regions where Cloud Firewall is available, see Supported regions.	cn-hangzhou
VpcId	string	No	The ID of the VPC instance.	vpc-8vbwbo90rq0anm6t****
NatGatewayId	string	No	The ID of the NAT Gateway.	ngw-bp123456g******
Status	string	No	The status of the Cloud Firewall. Valid values: configuring: The firewall is being created. deleting: The firewall is being deleted. normal: The firewall is working as expected. abnormal: The firewall is not working as expected. opening: The firewall is being enabled. closing: The firewall is being disabled. closed: The firewall is disabled.	normal
MemberUid	integer	No	The UID of the member account.	147783******

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of NAT firewalls.	10
RequestId	string	The ID of the request.	15FCCC52-1E23-57AE-B5EF-3E00A3******
NatFirewallList	array<object>	The list of Cloud Firewalls.
	array<object>	The list of Cloud Firewalls.
MemberUid	integer	The UID of the Cloud Firewall member account.	19106481******
AliUid	integer	The UID of the Alibaba Cloud account. Note This is the primary account of the Cloud Firewall member account.	19106481******
ProxyId	string	The ID of the NAT firewall.	proxy-nat30******
ProxyName	string	The name of the NAT firewall.	nat-防火墙测试
ProxyStatus	string	The status of the Cloud Firewall. Valid values: configuring: The firewall is being created. deleting: The firewall is being deleted. normal: The firewall is working as expected. abnormal: The firewall is not working as expected. opening: The firewall is being enabled. closing: The firewall is being disabled. closed: The firewall is disabled.	normal
RegionId	string	The region ID where the Cloud Firewall is located. Note For more information about the regions where Cloud Firewall is available, see Supported regions.	cn-qingdao
NatGatewayId	string	The ID of the NAT Gateway to query.	ngw-uf6tnblxip4qcxg******
NatGatewayName	string	The name of the NAT Gateway.	NAT网关测试
VpcId	string	The ID of the VPC instance.	vpc-2ze26ya******
VpcName	string	The name of the VPC instance.	vpc-测试实例
ErrorDetail	string	The cause of the error.	防火墙创建失败
StrictMode	integer	Indicates whether strict mode is enabled. 1: Strict mode is enabled. 0: Strict mode is disabled.	0
NatRouteEntryList	array<object>	The list of default route entries for the NAT Gateway.
	object	A default route entry for the NAT Gateway.
RouteTableId	string	The route table that contains the default route of the NAT Gateway.	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 `NatGateway`.	NatGateway
DestinationCidr	string	The destination CIDR block of the default route.	0.0.0.0/0
ProxyVSwitchId	string	The ID of the vSwitch that the firewall uses.	vsw-bp1amn3t1ktjjy8******
ProxyRouteTableId	string	The ID of the route table that the firewall uses.	vtb-bp1pmyga7p4j10a******
ProxyNetworkInterfaceId	string	The ID of the Elastic Network Interface (ENI) that the firewall uses.	eni-bp127llmo4v5qju******

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******\n",
  "NatFirewallList": [
    {
      "MemberUid": 0,
      "AliUid": 0,
      "ProxyId": "proxy-nat30******",
      "ProxyName": "nat-防火墙测试\n",
      "ProxyStatus": "normal",
      "RegionId": "cn-qingdao",
      "NatGatewayId": "ngw-uf6tnblxip4qcxg******",
      "NatGatewayName": "NAT网关测试\n",
      "VpcId": "vpc-2ze26ya******",
      "VpcName": "vpc-测试实例",
      "ErrorDetail": "防火墙创建失败",
      "StrictMode": 0,
      "NatRouteEntryList": [
        {
          "RouteTableId": "vtb-bp18o0gb******",
          "NextHopId": "ngw-2ze0s284r9atg5******",
          "NextHopType": "NatGateway",
          "DestinationCidr": "0.0.0.0/0"
        }
      ],
      "ProxyVSwitchId": "vsw-bp1amn3t1ktjjy8******",
      "ProxyRouteTableId": "vtb-bp1pmyga7p4j10a******",
      "ProxyNetworkInterfaceId": "eni-bp127llmo4v5qju******"
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.