DescribeVpcFirewallIPSWhitelist-阿里云帮助中心

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:DescribeVpcFirewallIPSWhitelist

get

*All Resource

*

None

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
MemberUid	integer	No	The UID of the Cloud Firewall member accounts.	176618****104675
VpcFirewallId	string	Yes	The instance ID of the VPC firewall. Valid values: If the VPC firewall protects network instances in a Cloud Enterprise Network (CEN) instance, the instance ID is the CEN instance ID. For CEN Basic Edition, call the DescribeVpcFirewallCenList operation to query the CEN instance ID. For CEN Enterprise Edition, call the DescribeTrFirewallsV2List operation to query the CEN instance ID. If the VPC firewall protects traffic between two VPCs connected through Express Connect, the instance ID is the VPC firewall instance ID. Call the DescribeVpcFirewallList operation to query the VPC firewall instance ID.	cen-***

Response elements

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