DescribeVfwIPSConfigList-阿里云帮助中心

Queries the IPS configuration list of a virtual private cloud (VPC) firewall.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type. Valid values: en : English. zh : Chinese.	zh
PageNo	integer	Yes	The current page number.	1
PageSize	integer	Yes	The number of entries per page.	10
VpcFirewallId	string	No	The instance ID of the virtual private cloud (VPC) firewall.	vfw-m5e7dbc4y****

Response elements

Element	Type	Description	Example
	object	Schema of Response
TotalCount	integer	The total number of entries.	2
PageNo	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	15FCCC52-1E23-57AE-B5EF-3E00A3******
VfwIpsSwitchConfigList	array<object>	The configuration list.
	object	The configuration list.
MemberUid	string	The UID of the member accounts.	134646920647****
VpcFirewallId	string	The instance ID of the virtual private cloud (VPC) firewall.	cen-h678sl4wv3yd5v****
VpcFirewallName	string	The instance name of the virtual private cloud (VPC) firewall.	vpc-test
RunMode	integer	The defense mode. Valid values: 0 : monitor mode. 1 : Block Mode.	1
BasicRules	integer	The status of the Basic Policies switch. Valid values: 0 : disabled. 1 : enabled.	1
PatchRules	integer	The status of the virtual patches switch. Valid values: 0 : disabled. 1 : enabled.	1
RuleClass	integer	The rule class for Block Mode. Valid values: 1 : loose. 2 : medium. 3 : strict.	1
VpcFirewallIdList	array	The list of instance IDs of virtual private cloud (VPC) firewalls.
	string	The instance ID of the virtual private cloud (VPC) firewall.	vfw-9f39c248f9f447c****

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******",
  "VfwIpsSwitchConfigList": [
    {
      "MemberUid": "134646920647****",
      "VpcFirewallId": "cen-h678sl4wv3yd5v****",
      "VpcFirewallName": "vpc-test",
      "RunMode": 1,
      "BasicRules": 1,
      "PatchRules": 1,
      "RuleClass": 1,
      "VpcFirewallIdList": [
        "vfw-9f39c248f9f447c****"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	Either pageSize or pageNo is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.