GetWafRuleset - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the details of a Web Application Firewall (WAF) ruleset, such as the configuration and status.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Id	long	No	The ID of the WAF ruleset, which can be obtained by calling the ListWafRulesets operation.	10000001
SiteId	long	No	The website ID, which can be obtained by calling the ListSites operation.	1
Phase	string	No	The WAF rule category of rulesets to query.	http_bot

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
UpdateTime	string	The time when the ruleset was last modified.	2024-01-01T00:00:00Z
Id	long	The ruleset ID.	10000001
Name	string	The ruleset name.	example
Status	string	The ruleset status.	on
Phase	string	The WAF rule category of the ruleset.	http_bot
Shared	WafBatchRuleShared	The configurations shared by the rules in the ruleset.
Rules	array	The rule configurations in the ruleset.
Rule	WafRuleConfig	The rule configuration in the ruleset.

Examples

Sample success responses

JSONformat

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "UpdateTime": "2024-01-01T00:00:00Z",
  "Id": 10000001,
  "Name": "example",
  "Status": "on",
  "Phase": "http_bot",
  "Shared": {
    "Target": "",
    "Mode": "",
    "CrossSiteId": 0,
    "Name": "",
    "Match": {
      "Logic": "",
      "Criteria": [
        {
          "Logic": "",
          "Criteria": [
            {
              "Logic": "",
              "Criteria": [
                {
                  "MatchType": "",
                  "MatchOperator": "",
                  "MatchValue": "",
                  "Negate": true,
                  "ConvertToLower": true
                }
              ],
              "MatchType": "",
              "MatchOperator": "",
              "MatchValue": "",
              "Negate": true,
              "ConvertToLower": true
            }
          ],
          "MatchType": "",
          "MatchOperator": "",
          "MatchValue": "",
          "Negate": true,
          "ConvertToLower": true
        }
      ],
      "MatchType": "",
      "MatchOperator": "",
      "MatchValue": "",
      "Negate": true,
      "ConvertToLower": true
    },
    "Action": "",
    "Actions": {
      "Response": {
        "Id": 0,
        "Code": 0
      }
    },
    "Expression": ""
  },
  "Rules": [
    {
      "Id": 0,
      "Name": "",
      "Status": "",
      "Type": "",
      "Match": {
        "Logic": "",
        "Criteria": [
          {
            "Logic": "",
            "Criteria": [
              {
                "Logic": "",
                "Criteria": [],
                "MatchType": "",
                "MatchOperator": "",
                "MatchValue": "",
                "Negate": true,
                "ConvertToLower": true
              }
            ],
            "MatchType": "",
            "MatchOperator": "",
            "MatchValue": "",
            "Negate": true,
            "ConvertToLower": true
          }
        ],
        "MatchType": "",
        "MatchOperator": "",
        "MatchValue": "",
        "Negate": true,
        "ConvertToLower": true
      },
      "Action": "",
      "Actions": {
        "Response": {
          "Id": 0,
          "Code": 0
        },
        "Bypass": {
          "Skip": "",
          "Tags": [
            ""
          ],
          "RegularTypes": [
            ""
          ],
          "RegularRules": [
            0
          ],
          "CustomRules": [
            0
          ]
        }
      },
      "ManagedGroupId": 0,
      "RateLimit": {
        "Characteristics": {
          "Logic": "",
          "Criteria": [
            {
              "Logic": "",
              "Criteria": [
                {
                  "Logic": "",
                  "Criteria": [
                    {
                      "MatchType": "",
                      "MatchOperator": "",
                      "MatchValue": "",
                      "Negate": true,
                      "ConvertToLower": true
                    }
                  ],
                  "MatchType": "",
                  "MatchOperator": "",
                  "MatchValue": "",
                  "Negate": true,
                  "ConvertToLower": true
                }
              ],
              "MatchType": "",
              "MatchOperator": "",
              "MatchValue": "",
              "Negate": true,
              "ConvertToLower": true
            }
          ],
          "MatchType": "",
          "MatchOperator": "",
          "MatchValue": "",
          "Negate": true,
          "ConvertToLower": true
        },
        "Threshold": {
          "Request": 0,
          "Traffic": "",
          "ManagedRulesBlocked": 0,
          "DistinctManagedRules": 0,
          "ResponseStatus": {
            "Code": 0,
            "Count": 0,
            "Ratio": 0
          }
        },
        "Interval": 0,
        "TTL": 0,
        "OnHit": true
      },
      "ManagedList": "",
      "Timer": {
        "Scopes": "",
        "Zone": 0,
        "Periods": [
          {
            "Start": "",
            "End": ""
          }
        ],
        "WeeklyPeriods": [
          {
            "Days": "",
            "DailyPeriods": [
              {
                "Start": "",
                "End": ""
              }
            ]
          }
        ]
      },
      "Sigchl": [
        ""
      ],
      "AppSdk": {
        "FeatureAbnormal": [
          ""
        ],
        "CustomSignStatus": "",
        "CustomSign": {
          "Key": "",
          "Value": ""
        }
      },
      "AppPackage": {
        "PackageSigns": [
          {
            "Name": "",
            "Sign": ""
          }
        ]
      },
      "Expression": "",
      "ManagedRulesets": [
        {
          "AttackType": 0,
          "NumberTotal": 0,
          "NumberEnabled": 0,
          "ProtectionLevel": 0,
          "Action": "",
          "ManagedRules": [
            {
              "Id": 0,
              "Status": "",
              "Action": ""
            }
          ]
        }
      ]
    }
  ]
}

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.

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

Change history

Change time	Summary of changes	Operation
2024-09-25	The Error code has changed	View Change Details
2024-09-18	The Error code has changed	View Change Details