DescribeHttpDDoSAttackRules - Edge Security Acceleration

Queries HTTP DDoS attack 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
SiteId	integer	Yes	The ID of the site. You can call the ListSites operation to obtain the site ID.	123456****
PageNumber	integer	Yes	The current page number. Default value: 1. Valid values: 1 to 65535.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	D4030CD2-0D9D-5E92-B358-421AE58307C6
TotalCount	integer	The total number of entries.	100
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
RuleInfos	array<object>	A list of rule details.
	object
RuleName	string	The name of the rule.	Illegal request。
RuleIdInfo	string	The short name of the rule.	global_01_s
RuleDesc	string	The description of the rule.	The HTTP request's Accept header contains invalid features#1
Status	string	The status of the rule. Valid values: on: The rule is enabled. off: The rule is disabled.	on
DefaultAction	string	The default action.	deny
Action	string	The action to perform.	deny
RuleId	integer	The ID of the HTTP DDoS protection rule.	20203578
LogRuleId	integer	The ID of the protection rule used for log records.	100010

Examples

Success response

JSON format

{
  "RequestId": "D4030CD2-0D9D-5E92-B358-421AE58307C6",
  "TotalCount": 100,
  "PageNumber": 1,
  "PageSize": 10,
  "RuleInfos": [
    {
      "RuleName": "Illegal request。",
      "RuleIdInfo": "global_01_s",
      "RuleDesc": "The HTTP request's Accept header contains invalid features#1",
      "Status": "on",
      "DefaultAction": "deny",
      "Action": "deny",
      "RuleId": 20203578,
      "LogRuleId": 100010
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.SiteId	The specified SiteId is invalid.	The specified SiteId is invalid.Check parameter SiteId and try again.
400	ErrSiteIdNoteEnterprise	This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.	This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.
500	InternalError	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
403	SiteIdDDoSVersionCheckFailed	SiteId DDoS version check failed.	Failed to check the DDoS version corresponding to the site.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.