Retrieve WAF Ruleset Details via GetUserWafRuleset to Audit Configurations - Edge Security Acceleration

This API retrieves the details of the WAF rule set for a specified instance.

Operation description

Request

GetUserWafRuleset retrieves the details of a specific Web Application Firewall (WAF) ruleset, identified by its instance ID and ruleset ID. The response includes details such as the ruleset's location, name, description, status, and its rules. Specify all required parameters correctly to prevent request failures.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance.	esa-xxxxxxx
Id	integer	Yes	The ID of the WAF ruleset.	10000001

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Ruleset	object	The WAF rule set.	{}
Id	integer	The ID of the WAF rule set.	10000001
Position	integer	The position of the WAF rule set.	1
Name	string	The name of the WAF rule set.	example
Description	string	The description of the WAF rule set.	example
Status	string	The status of the WAF rule set.	on
Expression	string	The expression of the WAF rule set.	ip.src == 1.1.1.1
Phase	string	The evaluation phase of the WAF rule set. Valid values: `http_whitelist`: A whitelist rule. `http_custom`: A custom rule. `http_managed`: A managed rule. `http_anti_scan`: A scan protection rule. `http_ratelimit`: A rate limiting rule. `ip_access_rule`: An IP access rule. `http_bot`: A bot management rule. `http_security_level_rule`: A security level rule.	http_custom
Shared	WafBatchRuleShared	The shared configuration of the WAF rule set.	{}
Rules	array<object>	A list of rules in the WAF rule set.	[{}]
	object	A rule in the rule set.	{}
UpdateTime	string	The time the WAF rule was last updated.	2025-07-07T15:00:00Z
RulesetId	integer	The ID of the WAF rule set.	10000001
Id	integer	The ID of the WAF rule.	20000001
Position	integer	The position of the WAF rule.	1
Phase	string	The evaluation phase of the WAF rule. Valid values: `http_whitelist`: A whitelist rule. `http_custom`: A custom rule. `http_managed`: A managed rule. `http_anti_scan`: A scan protection rule. `http_ratelimit`: A rate limiting rule. `ip_access_rule`: An IP access rule. `http_bot`: A bot management rule. `http_security_level_rule`: A security level rule.	http_custom
Type	string	The type of the WAF rule.	http_ratelimit
Name	string	The name of the WAF rule.	example
Status	string	The status of the WAF rule.	on
Fields	array	A list of WAF rule match fields.	["ip.src"]
	string	A WAF rule match field.	ip.src
CharacteristicsFields	array	A list of WAF rule statistics fields.	["http.host"]
	string	A WAF rule statistics field.	http.host
Action	string	The action for the rule. Valid values: `deny`: Blocks the request. `monitor`: Monitors the request. `js`: Triggers a JS challenge. `captcha`: Triggers a CAPTCHA challenge.	deny
Skip	string	The skip mode for the WAF rule.	all
Tags	array	The phases that the rule skips.	["http_custom"]
	string	A phase that the rule skips.	http_custom
Config	WafRuleConfig	The WAF rule configuration.	{ "Id": 20000001, "Name": "rule1", "Expression": "ip.src eq 1.1.1.1", "Action": "deny" }

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Ruleset": {
    "Id": 10000001,
    "Position": 1,
    "Name": "example",
    "Description": "example",
    "Status": "on",
    "Expression": "ip.src == 1.1.1.1",
    "Phase": "http_custom",
    "Shared": {
      "Target": "web",
      "Mode": "automatic",
      "CrossSiteId": 10000001,
      "Name": "example",
      "Match": {
        "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
      },
      "Action": "deny",
      "Actions": {
        "Response": {
          "Id": 50000001,
          "Code": 403
        }
      },
      "Expression": "ip.src eq 1.1.1.1"
    },
    "Rules": [
      {
        "UpdateTime": "2025-07-07T15:00:00Z",
        "RulesetId": 10000001,
        "Id": 20000001,
        "Position": 1,
        "Phase": "http_custom",
        "Type": "http_ratelimit",
        "Name": "example",
        "Status": "on",
        "Fields": [
          "ip.src"
        ],
        "CharacteristicsFields": [
          "http.host"
        ],
        "Action": "deny",
        "Skip": "all",
        "Tags": [
          "http_custom"
        ],
        "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.