DescribeSecurityProxy - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the details of NAT firewalls.

Note

This API has been deprecated. We recommend migrating to Cloudfw(2017-12-07) - DescribeNatFirewallList for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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 request and response. Valid values: zh (default): Chinese. en: English.	zh
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese. en: English.	zh
ProxyId	string	No	The ID of the NAT firewall.	proxy-nat80d763eb0dee4eacaec9
ProxyName	string	No	The name of the NAT firewall. The name must be 4 to 50 characters in length. It can contain letters, digits, underscores (_), and Chinese characters. It cannot start with an underscore (_).	nat-idmp-fir
RegionNo	string	No	The region ID of the VPC.	cn-hangzhou
VpcId	string	No	The ID of the VPC instance.	vpc-8vbwbo90rq0anm6t****
NatGatewayId	string	No	The ID of the NAT Gateway.	ngw-zm0h3c1exm5bifuorg8c5
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 running. abnormal: The firewall is not running as expected. opening: The firewall is being enabled. closing: The firewall is being disabled. closed: The firewall is disabled.	normal
PageNo	string	No	The page number of the current page.	1
PageSize	string	No	The maximum number of entries to return on each page. The maximum value is 50.	10
MemberUid	string	No	The UID of the member account within the current Alibaba Cloud account.	258039427902****

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	5
RequestId	string	The ID of the request.	F0F82705-CFC7-5F83-86C8-A063892F****
ProxyList	array<object>	The list of NAT firewalls.
	object	The information about the NAT firewalls.
VpcId	string	The ID of the VPC instance.	vpc-wz9xn35tq33hunzvpu0se
Status	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 running. abnormal: The firewall is not running as expected. opening: The firewall is being enabled. closing: The firewall is being disabled. closed: The firewall is disabled.	normal
RegionNo	string	The region ID of the VPC.	ap-southeast-1
NatGatewayName	string	The name of the NAT Gateway.	ecs-slb-eip-waf
MemberUid	string	The UID of the Cloud Firewall member account.	1797733170015112
ProxyId	string	The ID of the NAT firewall.	proxy-nat4921f192b6cf438d93f8
ProxyName	string	The name of the NAT firewall.	nat-idmp-fir
VpcName	string	The instance name of the VPC.	vpc-bp1kw9igsq0yyzeanqamx
VSwitchId	string	The ID of the vSwitch to which the Cloud Firewall instance belongs.	vsw-5gu2qqfmjmwl8ktzgfekl
CidrBlock	string	The IPv4 CIDR block of the VPC.	192.168.0.0/16
NatGatewayId	string	The ID of the NAT Gateway.	ngw-2zex8sf4s5vus8rq3rjqo
Detail	string	The details of the exception.	“”
SnatIpList	array	The list of SNAT IP addresses.
	string	The list of SNAT IP addresses.	""
StrictMode	integer	Indicates whether the strict mode is enabled. 1: The strict mode is enabled. 0: The strict mode is disabled.	0

Examples

Success response

JSON format

{
  "TotalCount": 5,
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
  "ProxyList": [
    {
      "VpcId": "vpc-wz9xn35tq33hunzvpu0se",
      "Status": "normal",
      "RegionNo": "ap-southeast-1",
      "NatGatewayName": "ecs-slb-eip-waf",
      "MemberUid": "1797733170015112",
      "ProxyId": "proxy-nat4921f192b6cf438d93f8",
      "ProxyName": "nat-idmp-fir",
      "VpcName": "vpc-bp1kw9igsq0yyzeanqamx",
      "VSwitchId": "vsw-5gu2qqfmjmwl8ktzgfekl",
      "CidrBlock": "192.168.0.0/16",
      "NatGatewayId": "ngw-2zex8sf4s5vus8rq3rjqo",
      "Detail": "“”",
      "SnatIpList": [
        "\"\""
      ],
      "StrictMode": 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	ErrorMarshalJSON	internal error.	Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.