DescribeRelatedDefenseRules - Web Application Firewall - Alibaba Cloud Documentation Center

Queries a paginated list of associated protection rules.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call the DescribeInstance operation to query the ID of your WAF instance.	waf-cn-zz11sr5****
RuleId	integer	Yes	The ID of the rule to query.	12345678
DefenseType	string	Yes	The type of the protection rule. Only the following value is supported: global: a global rule.	global
NextToken	string	No	The token that is used to query the next page of results. If more results are available, this parameter is returned. Note If this parameter is returned, more results are available. Use the returned NextToken value as a request parameter to retrieve the next page of data. Repeat this process until the NextToken parameter is not returned. This indicates that all data has been retrieved.	caeba0bbb2be03f84eb48b699f0*****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	20
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
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
DefenseScene	string	Yes	The WAF protection scenario. Only the following value is supported: address_book: address book. Valid values: address_book : address_book	address_book

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	10
RequestId	string	The ID of the request.	F35F45B0-5D6B-4238-BE02-A62D****E840
Rules	array<object>	The list of associated rules.
	object	The information about the associated rule.
RuleId	integer	The ID of the protection rule.	2456789
TemplateId	integer	The ID of the protection template.	81501
DefenseScene	string	The protection scenario of the rule. For more information, see the description of the DefenseScene parameter in DescribeDefenseRules.	custom_acl
DefenseType	string	The type of the protection rule. Valid values: template (default): a template rule. resource: a rule for a protected object. global: a global rule.	template
RuleName	string	The name of the protection rule.	ruleTest
NextToken	string	The token that is used to query the next page of results. If more results are available, this parameter is returned. Note If this parameter is returned, more results are available. Use the returned NextToken value as a request parameter to retrieve the next page of data. Repeat this process until the NextToken parameter is not returned. This indicates that all data has been retrieved.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	20

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D****E840",
  "Rules": [
    {
      "RuleId": 2456789,
      "TemplateId": 81501,
      "DefenseScene": "custom_acl",
      "DefenseType": "template",
      "RuleName": "ruleTest"
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.