DescribeVpcFirewallIPSWhitelist - Cloud Firewall - Alibaba Cloud Documentation Center

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 messages. Valid values: zh (default): Chinese en: English	zh
MemberUid	integer	No	The UID of the Cloud Firewall member account.	176618****104675
VpcFirewallId	string	Yes	The instance ID of the VPC firewall. Valid values: If the VPC firewall protects a network instance in a Cloud Enterprise Network (CEN) instance, set the value to the ID of the CEN instance. For a CEN instance of Basic Edition, you can call the DescribeVpcFirewallCenList operation to query the instance ID. For a CEN instance of Enterprise Edition, you can call the DescribeTrFirewallsV2List operation to query the instance ID. If the VPC firewall protects traffic between two VPCs that are connected by an Express Connect circuit, set the value to the instance ID of the VPC firewall. You can call the DescribeVpcFirewallList operation to query the instance ID of the VPC firewall.	cen-***

Response elements

Element	Type	Description	Example
	object	Response parameters
RequestId	string	The ID of the request.	B5EE02F9**AA49**F9F8D69483C1
Whitelists	array<object>	The details of the IPS whitelist for the VPC firewall.
	object	The details of the IPS whitelist for the VPC firewall.
VpcFirewallId	string	The instance ID of the VPC firewall.	cen-l6t5yj5fi762******
WhiteType	integer	The type of the whitelist. Valid values: 1: destination 2: source	1
ListValue	string	The value of the list.	10.10.200.4/32,10.10.200.25/32
ListType	integer	The type of the list. Valid values: 1: custom 2: address book	1
WhiteListValue	array	The content of the list.
	string	The content of the list.	10.10.200.4/32

Examples

Success response

JSON format

{
  "RequestId": "B5EE02F9****AA49****F9F8D69483C1",
  "Whitelists": [
    {
      "VpcFirewallId": "cen-l6t5yj5fi762******",
      "WhiteType": 1,
      "ListValue": "10.10.200.4/32,10.10.200.25/32",
      "ListType": 1,
      "WhiteListValue": [
        "10.10.200.4/32"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
200	ErrorParametersUid	The aliUid is invalid.	The aliUid is invalid.
400	ErrorParametersFirewallId	Invalid VPC firewall ID.	The VPC firewall ID is invalid.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorMarshalJSON	internal error: marshal json.	An error occurred. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.