DescribeApisecRules - - Alibaba Cloud Documentation Center

Queries the policies configured in the API security module.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-waf:DescribeApisecRules	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_elasticity-cn-0x***
Param	string	No	The keyword that is used to query policies based on fuzzy match.	origin
Type	string	Yes	The type of the policy. Valid values: risk: risk detection event: security event sensitive_word: sensitive data auth_flag: authentication credential api_tag: business purpose desensitization: masking whitelist: whitelist recognition: API recognition offline_api: lifecycle management	risk
Level	string	No	The level of the policy. If Type is set to risk or event, you can set this parameter to one of the following values: high medium low If Type is set to sensitive_word, you can set this parameter to one of the following values: S1 S2 S3 S4	high
Name	string	No	The name of the policy.	Information Leak
Origin	string	No	The source of the policy. Valid values: custom default	custom
Status	long	No	The status of the policy. Valid values: 1: enabled 0: disabled	1
PageNumber	long	Yes	The page number. Default value: 1.	1
PageSize	long	Yes	The number of entries per page. Default value: 10.	10
RegionId	string	No	The region in which the WAF instance is deployed. Valid values: cn-hangzhou: Chinese mainland ap-southeast-1: outside the Chinese mainland	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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}"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.