DescribeHttpDDoSIntelligentRateLimitRules - Edge Security Acceleration

Queries the frequency control rules generated by Deep Learning and Protection.

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 site ID. Obtain this by calling the ListSites operation.	123456****
PageNumber	integer	Yes	The current page number.	1
PageSize	integer	No	The number of entries per page.	10
RuleType	string	No	The rule type.	cc

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	36af3fcc-43d0-441c-86b1-428951dc8225
TotalCount	integer	The total number of rules.	100
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
RuleInfos	array<object>	The list of rules.
	object
RuleName	string	The name of the rule.	inner_cc_client_ip_ratelimit
RecordName	string	The name of the record.	test.example.com
Action	string	The action to perform.	js
RuleId	integer	The ID of the rule.	20110849
RateLimit	string	The frequency information.	{"threshold":2000,"interval":5,"target":"ip","ttl":600}
Statistics	string	The statistics.	{"field":"ip","mode":"count"}
Condition	string	The conditions that trigger the rule.	{"$and":[{"key":"URI","opValue":"prefix-match","values":"/"}]}
PunishTime	integer	The duration of the penalty in seconds.	86400
LogRuleId	integer	The ID of the protection rule for log records.	100030

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "TotalCount": 100,
  "PageNumber": 1,
  "PageSize": 10,
  "RuleInfos": [
    {
      "RuleName": "inner_cc_client_ip_ratelimit",
      "RecordName": "test.example.com",
      "Action": "js",
      "RuleId": 20110849,
      "RateLimit": "{\"threshold\":2000,\"interval\":5,\"target\":\"ip\",\"ttl\":600}",
      "Statistics": "{\"field\":\"ip\",\"mode\":\"count\"}",
      "Condition": "{\"$and\":[{\"key\":\"URI\",\"opValue\":\"prefix-match\",\"values\":\"/\"}]}",
      "PunishTime": 86400,
      "LogRuleId": 100030
    }
  ]
}

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.