Retrieve WAF Template Rules with ListWafTemplateRules API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

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

esa:ListWafTemplateRules

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	No	The site ID. To obtain this ID, call the ListSites API.	1
InstanceId	string	No	The instance ID.	esa-site-aud6ftk57ym8
Phase	string	No	The WAF execution phase used to filter template rules.	http_anti_scan
QueryArgs	object	No	Query conditions for filtering template rules, such as rule type.	http_anti_scan
Type	string	No	The rule type.	http_directory_traversal
Kinds	array	No	A list of template kinds.
	string	No	The template kind. Valid values: template : template template-featured : template-featured	template

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Rules	array<object>	A list of template rules.
	object	The details of a template rule.
Name	string	The rule name.	HTTP Directory Traversal Rule [Template]
Status	string	The rule status.	on
Type	string	The rule type.	http_directory_traversal
Phase	string	The WAF running phase.	http_anti_scan
Config	WafRuleConfig	The rule configuration.

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Rules": [
    {
      "Name": "HTTP Directory Traversal Rule [Template]",
      "Status": "on",
      "Type": "http_directory_traversal",
      "Phase": "http_anti_scan",
      "Config": {
        "Status": "on",
        "Action": "deny",
        "Actions": {
          "Response": {
            "Id": 50000001,
            "Code": 403
          },
          "Bypass": {
            "Skip": "part",
            "RegularRules": [
              100001
            ],
            "CustomRules": [
              20000001
            ],
            "RegularTypes": [
              "sqli"
            ],
            "Tags": [
              "http_custom"
            ]
          }
        },
        "ManagedList": "intelligence_crawler",
        "ManagedRulesets": [
          {
            "ProtectionLevel": 4,
            "Action": "deny",
            "ManagedRules": [
              {
                "Status": "on",
                "Action": "deny",
                "Id": 100001
              }
            ],
            "AttackType": 11,
            "NumberTotal": 100,
            "NumberEnabled": 50
          }
        ],
        "Sigchl": [
          "sig"
        ],
        "Name": "example",
        "AppSdk": {
          "CustomSign": {
            "Value": "examplesignvalue",
            "Key": "sign"
          },
          "CustomSignStatus": "on",
          "FeatureAbnormal": [
            "wxbb_invalid_sign"
          ]
        },
        "RateLimit": {
          "Characteristics": {
            "Logic": "and",
            "Criteria": [
              {
                "Logic": "and",
                "Criteria": [
                  {
                    "Logic": "and",
                    "Criteria": [
                      {
                        "MatchType": "ip.src",
                        "MatchOperator": "eq",
                        "MatchValue": "1.1.1.1",
                        "Negate": true,
                        "ConvertToLower": true
                      }
                    ],
                    "MatchType": "ip.src",
                    "MatchOperator": "eq",
                    "MatchValue": "1.1.1.1",
                    "Negate": true,
                    "ConvertToLower": true
                  }
                ],
                "MatchType": "ip.src",
                "MatchOperator": "eq",
                "MatchValue": "1.1.1.1",
                "Negate": true,
                "ConvertToLower": true
              }
            ],
            "MatchType": "ip.src",
            "MatchOperator": "eq",
            "MatchValue": "1.1.1.1",
            "Negate": true,
            "ConvertToLower": true
          },
          "OnHit": true,
          "TTL": 10,
          "Threshold": {
            "ManagedRulesBlocked": 10,
            "DistinctManagedRules": 10,
            "ResponseStatus": {
              "Ratio": 10,
              "Count": 10,
              "Code": 404
            },
            "Traffic": "10Gb",
            "Request": 10
          },
          "Interval": 10
        },
        "Type": "http_custom",
        "AppPackage": {
          "PackageSigns": [
            {
              "Sign": "sign",
              "Name": "name"
            }
          ]
        },
        "ManagedGroupId": 30000001,
        "Timer": {
          "Scopes": "permanent",
          "Zone": 8,
          "Periods": [
            {
              "Start": "2025-01-01T00:00:00Z",
              "End": "2025-01-01T01:00:00Z"
            }
          ],
          "WeeklyPeriods": [
            {
              "Days": "1",
              "DailyPeriods": [
                {
                  "Start": "00:00:00",
                  "End": "01:00:00"
                }
              ]
            }
          ]
        },
        "Expression": "ip.src eq 1.1.1.1",
        "SecurityLevel": {
          "Value": "low"
        },
        "Value": "10.0.0.1",
        "Id": 20000001,
        "Notes": "example notes"
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.