Call DescribeDefenseRule to query protection rule details - Web Application Firewall

Retrieves the details of a specified protection rule.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note Call the DescribeInstance operation to query the ID of the WAF instance.	waf_cdnsdf3****
TemplateId	integer	No	The ID of the protection rule template. Note This parameter is required only when DefenseType is set to template.	10318
RuleId	integer	Yes	The ID of the protection rule.	20026192
DefenseType	string	No	The type of the protection rule. Valid values: template (default): a protection rule template. resource: a rule for a protected object. global: a global rule. Valid values: template : template resource : resource	template
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
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
Resource	string	No	The protected object to which the protection rule applies. Note This parameter is required only when DefenseType is set to resource.	rencs***-waf

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Rule	object	The details of the protection rule.
Status	integer	The status of the protection rule. Valid values: 0: disabled. 1: enabled.	1
DefenseOrigin	string	The origin of the protection rule. This parameter indicates whether the rule was created by the user or by the system. Valid values: custom: a custom rule. system: a system-generated rule.	custom
Config	string	The configuration of the protection rule, returned as a JSON string. For more information, see the Protection rule parameters section in CreateDefenseRule.	{\"status\":1,\"policyId\":1012,\"action\":\"block\"}
RuleId	integer	The ID of the protection rule.	2732975
DefenseScene	string	The scenario to which the protection rule applies. If the DefenseType parameter is set to template, the valid values are: waf_group: basic protection with regular expression rules. waf_base: web core protection. waf_base_compliance: basic protection with protocol compliance rules. waf_base_sema: basic protection with semantic analysis rules. cc: HTTP flood protection. antiscan_dirscan: directory traversal blocking in scan protection. antiscan_highfreq: high-frequency scan blocking in scan protection. antiscan_scantools: scanning tool blocking in scan protection. ip_blacklist: an IP address blacklist. custom_acl: a custom rule. region_block: a location blacklist. tamperproof: webpage tamper protection. dlp: data leakage prevention. custom_response_block: a custom response. spike_throttle: peak traffic throttling. If the DefenseType parameter is set to resource, the valid values are: account_identifier: account identification. custom_response: a custom response. waf_codec: data decoding settings. If the DefenseType parameter is set to global, the valid values are: regular_custom: a custom regular expression. address_book: an IP address book. custom_response: a custom response.	waf_group
GmtModified	integer	The time when the protection rule was modified. This value is a UNIX timestamp. Unit: milliseconds.	1665196746000
RuleName	string	The name of the protection rule.	test1
TemplateId	integer	The ID of the protection rule template. Note This parameter is returned only if the DefenseType parameter is set to template.	9114
Resource	string	The protected object to which the protection rule applies. Note This parameter is returned only if the DefenseType parameter is set to resource.	rencs***-waf
DefenseType	string	The type of the protection rule. Valid values: template (default): a protection rule template. resource: a rule for a protected object. global: a global rule.	template

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.