DescribeDefenseRule - Web Application Firewall - Alibaba Cloud Documentation Center

Queries a protection rule.

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:DescribeDefenseRule	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 obtain the ID of the WAF instance.	waf_cdnsdf3****
TemplateId	long	Yes	The ID of the protection rule template to which the protection rule that you want to query belongs.	10318
RuleId	long	Yes	The ID of the protection rule that you want to query.	20026192
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland ap-southeast-1: outside the Chinese mainland.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Rule	object	The configurations of the protection rule. The value is a JSON string that contains multiple parameters.
Config	string	The details of the protection rule. The value is a JSON string that contains multiple parameters. For more information, see the "Protection rule parameters" section of the CreateDefenseRule topic.	{\"status\":1,\"policyId\":1012,\"action\":\"block\"}
DefenseOrigin	string	The origin of the protection rule. Valid values: custom: The protection rule is created by the user. system: The protection rule is automatically generated by the system.	custom
DefenseScene	string	The scenario in which the protection rule is used. For more information, see the description of DefenseScene in the CreateDefenseRule topic.	waf_group
GmtModified	long	The most recent time when the protection rule was modified.	1665196746000
RuleId	long	The ID of the protection rule.	2732975
RuleName	string	The name of the protection rule.	test1
Status	integer	The status of the protection rule. Valid values: 0: disabled. 1: enabled.	1
TemplateId	long	The ID of the protection rule template.	9114

Examples

Sample success responses

JSONformat

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Rule": {
    "Config": "{\\\"status\\\":1,\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
    "DefenseOrigin": "custom",
    "DefenseScene": "waf_group",
    "GmtModified": 1665196746000,
    "RuleId": 2732975,
    "RuleName": "test1",
    "Status": 1,
    "TemplateId": 9114
  }
}

Error codes

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