DescribeApisecRules - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the rules of an API security policy.

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

get

*All Resource

*

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 current WAF instance.	waf_elasticity-cn-0x***
Type	string	Yes	The type of the rule. Valid values: risk: threat detection event: security event sensitive_word: sensitive data auth_flag: authentication credential api_tag: business purpose desensitization: data masking whitelist: whitelist recognition: API offline_api: lifecycle management	risk
Level	string	No	The level of the rule. For threat detection (risk) and security events (event), valid values are: high: important medium: medium low: low For sensitive data (sensitive_word), valid values are: S1: S1 S2: S2 S3: S3 S4: S4	high
Name	string	No	The name of the rule.	information leakage
Origin	string	No	The source of the rule. Valid values: custom: custom default: built-in	custom
Status	integer	No	The enabling status of the rule. Valid values: 1: enabled 0: disabled	1
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
RegionId	string	No	The region of the WAF instance. Valid values: cn-hangzhou: the Chinese mainland ap-southeast-1: outside the Chinese mainland	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q
Lang	string	No	The language of the response. Valid values: zh (default): Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of entries returned.	6
RequestId	string	The ID of the request.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Data	array<object>	The list of rules.
	object	The information about the rule.
Status	integer	The status of the rule. Valid values: 1: enabled 0: disabled	1
Type	string	The type of the rule. Valid values: risk: threat detection event: security event sensitive_word: sensitive data auth_flag: authentication credential api_tag: business purpose desensitization: data masking whitelist: whitelist recognition: API. offline_api: lifecycle management	risk
UpdateTime	integer	The time when the rule was updated. This value is a UNIX timestamp. Unit: seconds.	1721095301
Id	integer	The ID of the rule.	34933
Rule	string	The details of the rule. The value is a string that is converted from a JSON object.	{ "ext": "Date", "regex": "-", "code": "2009", "level": "S1", "origin": "default", "name": "2009" }

Examples

Success response

JSON format

{
  "TotalCount": 6,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "Status": 1,
      "Type": "risk",
      "UpdateTime": 1721095301,
      "Id": 34933,
      "Rule": "{\n    \"ext\": \"Date\",\n    \"regex\": \"-\",\n    \"code\": \"2009\",\n    \"level\": \"S1\",\n    \"origin\": \"default\",\n    \"name\": \"2009\"\n}\n"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.