Query NAT Firewall Details with DescribeNatFirewallList - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Retrieves the details of NAT firewalls.

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

yundun-cloudfirewall:DescribeNatFirewallList

get

*NatFirewall

acs:cloudfirewall::{#accountId}:natfirewall/{#ProxyId}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh (default): Chinese en: English	zh
PageNo	integer	No	The page number of the current page.	1
PageSize	integer	No	The number of NAT firewalls to display on each page in a paged query. Default value: 10, which indicates that each page contains 10 results. Maximum value: 50.	10
ProxyId	string	No	The NAT firewall ID.	proxy-nat97a******
ProxyName	string	No	The NAT firewall name. The name can contain uppercase and lowercase letters, Chinese characters, digits, and underscores (_). The name must be 4 to 50 characters in length and cannot start with an underscore.	nat-firewall
RegionNo	string	No	The region ID of the VPC. Note For more information about the regions supported by Cloud Firewall, see Supported regions.	cn-hangzhou
VpcId	string	No	The VPC-connected instance ID.	vpc-8vbwbo90rq0anm6t****
NatGatewayId	string	No	The NAT gateway ID.	ngw-bp123456g******
Status	string	No	The Cloud Firewall status. Valid values: configuring: being created deleting: being deleted normal: normal abnormal: abnormal opening: being enabled closing: being disabled closed: disabled	normal
MemberUid	integer	No	The UID of the member account of the current Alibaba Cloud account.	147783******

Response elements

Element	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 list of Cloud Firewalls.
	array<object>	The list of Cloud Firewalls.
MemberUid	integer	The UID of the Cloud Firewall member accounts.	19106481******
AliUid	integer	The UID of the Alibaba Cloud account. Note The management account of the Cloud Firewall member accounts.	19106481******
ProxyId	string	The NAT firewall ID.	proxy-nat30******
ProxyName	string	The NAT firewall name.	nat-firewall-test
ProxyStatus	string	The Cloud Firewall status. Valid values: configuring: being created deleting: being deleted normal: normal abnormal: abnormal opening: being enabled closing: being disabled closed: disabled	normal
RegionId	string	The region ID of the Cloud Firewall. Note For more information about the regions supported by Cloud Firewall, 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-gateway-test
VpcId	string	The VPC-connected instance ID.	vpc-2ze26ya******
VpcName	string	The name of the VPC instance.	vpc-test-instance
ErrorDetail	string	The error details.	Firewall creation failed
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	The 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 original next hop address of the NAT gateway.	ngw-2ze0s284r9atg5******
NextHopType	string	The network type of the next hop. Valid values: NatGateway.	NatGateway
DestinationCidr	string	The destination CIDR block of the default route.	0.0.0.0/0
ProxyVSwitchId	string	The vSwitch ID used by the firewall.	vsw-bp1amn3t1ktjjy8******
ProxyRouteTableId	string	The route table ID used by the firewall.	vtb-bp1pmyga7p4j10a******
ProxyNetworkInterfaceId	string	The elastic network interface (ENI) ID used by the firewall.	eni-bp127llmo4v5qju******
FirewallServiceMode	string	The deployment mode of the NAT firewall service. Valid values: PrimaryStandby (active/standby mode) and MultiPrimary (active-active mode).	PrimaryStandby
FirewallServiceZones	array	The list of zone IDs used by the NAT firewall service.
	string	The zone ID used by the NAT firewall service.	cn-hangzhou-i

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******\n",
  "NatFirewallList": [
    {
      "MemberUid": 0,
      "AliUid": 0,
      "ProxyId": "proxy-nat30******",
      "ProxyName": "nat-firewall-test\n",
      "ProxyStatus": "normal",
      "RegionId": "cn-qingdao",
      "NatGatewayId": "ngw-uf6tnblxip4qcxg******",
      "NatGatewayName": "nat-gateway-test\n",
      "VpcId": "vpc-2ze26ya******",
      "VpcName": "vpc-test-instance",
      "ErrorDetail": "Firewall creation failed",
      "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******",
      "FirewallServiceMode": "PrimaryStandby",
      "FirewallServiceZones": [
        "cn-hangzhou-i"
      ]
    }
  ]
}

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.