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-waf:DescribeDefenseRuleStatistics

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the WAF instance.	waf_elasticity-cn-0xldbqt****
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
TemplateId	integer	Yes	The ID of the protection template that you want to query.	239136
PrimaryKey	string	Yes	The primary query condition. Valid values: riskLevel : Threat level detectType : Detection type action : Rule action scene : Protection scenario status : Rule status	scene
SecondaryKey	string	No	The secondary query condition. The value cannot be the same as the primary query condition. Valid values: riskLevel : Threat level detectType : Detection type action : Rule action type : Rule type scene : Protection scenario status : Rule status	action
ThirdKey	string	No	The tertiary query condition. The value cannot be the same as the primary or secondary query condition. Valid values: riskLevel : Threat level detectType : Detection type action : Rule action scene : Protection scenario status : Rule status	status
FourthKey	string	No	The quaternary query condition. The value cannot be the same as the primary, secondary, or tertiary query condition. Valid values: riskLevel : Threat level detectType : Detection type action : Rule action scene : Protection scenario status : Rule status	riskLevel
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q

Query condition details

This operation supports the following protection scenarios (for the scene parameter): Bot Management (bot_manager) and Web Intrusion Prevention (waf_base).

Bot Management (bot_manager)

The following parameters are supported for querying statistics at each level.

Parameter descriptions

Name	Type	Description
scene	String	Counts the number of rules by protection scenario.
status	Integer	Counts the number of rules by rule status.
action	String	Counts the number of rules by rule action.

Web Intrusion Prevention (waf_base)

The following parameters are supported for querying statistics at each level.

Parameter descriptions

Name	Type	Description
type	String	Counts the number of rules of different types.
detectType	String	Counts the number of rules by detection type.
riskLevel	String	Counts the number of rules by threat level.
status	Integer	Counts the number of rules by rule status.
action	String	Counts the number of rules by rule action.

Note

The type parameter can be used only as a primary query condition. It counts the number of system protection rules (system) and custom regular expression rules (custom).

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
StatisticsInfos	array<object>	The statistics.
	object	The statistics.
PrimaryValue	string	The value of the primary query condition.	sytem
SecondaryValue	string	The value of the secondary query condition.	block
ThirdValue	string	The value of the tertiary query condition.	1
FourthValue	string	The value of the quaternary query condition.	action
Count	integer	The number of rules that meet the query conditions.	27

Examples

Success response

JSON format

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "StatisticsInfos": [
    {
      "PrimaryValue": "sytem",
      "SecondaryValue": "block",
      "ThirdValue": "1",
      "FourthValue": "action",
      "Count": 27
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.