DescribeWebCCRulesV2 - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the custom rules for website frequency control protection (HTTP flood 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

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

yundun-ddoscoo:DescribeWebCCRulesV2

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Domain	string	No	The domain name of the website to be protected by Anti-DDoS Proxy.	example.com
PageSize	string	No	The number of entries to return on each page. Maximum value: 20. Default value: 20.	20
Offset	string	No	The beginning position from which to start the query. Default value: 0.	0
Owner	string	No	The source of the rule. Valid values: manual (default): manually added clover: automatically generated	manual

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request, which is generated by Alibaba Cloud for the request and can be used for troubleshooting and problem locating.	CF33B4C3-196E-4015-AADD-5CAD00057B80
TotalCount	string	The total number of frequency control rules.	12
Domain	string	The domain name of the website.	www.aliyun.com
WebCCRules	array<object>	The custom rules for frequency control (HTTP flood protection).
	array<object>	The custom rule for frequency control (HTTP flood protection).
Owner	string	The source of the rule. Valid values: manual (default): manually added clover: automatically generated	manual
Expires	integer	The validity period of the rule. Unit: seconds. This parameter takes effect when the matching action of the rule is block (action is block). Access requests are blocked during the validity period of the rule. The value 0 indicates that the rule is permanently valid.	0
Name	string	The name of the rule.	wq
RuleDetail	object	The details of the rule.
Mode	string	The old rule format, which is deprecated.	废弃
Count	integer	The old rule format, which is deprecated.	废弃
Name	string	The name of the rule.	ccauto14
Action	string	The matching action. Valid values: accept: allows the request block: blocks the request challenge: initiates JavaScript Challenge watch: monitors the request	block
Interval	integer	The old rule format, which is deprecated.	60
Ttl	integer	The old rule format, which is deprecated.	300
Uri	string	The old rule format, which is deprecated.	/p3shijihao
RateLimit	object	The frequency statistics.
SubKey	string	The field name (set only when the statistical source is header).	action
Interval	integer	The statistical period. Unit: seconds.	60
Threshold	integer	The trigger threshold.	20
Ttl	integer	The blocking duration. Unit: seconds.	15
Target	string	The statistical source. Valid values: ip: statistics by IP address header: statistics by header	ip
Condition	array<object>	The list of matching conditions.
	object	The matching condition.
MatchMethod	string	The matching method.	belong
Field	string	The matching field.	ip
HeaderName	string	The name of the custom HTTP header field. Note This parameter takes effect only when Field is set to header.	null
Content	string	The matching content.	192.0.XX.XX
ContentList	string	The matching content when the matching method is equal to one of multiple values.	["2","3","ad"]
Statistics	object	The deduplication statistics, which can be omitted (omitted means no deduplication statistics).
Mode	string	The deduplication mode. Valid values: count: no deduplication statistics distinct: deduplication statistics	count
Field	string	The statistical source. Valid values: ip: statistics by IP address header: statistics by header uri: statistics by URI	uri
HeaderName	string	Set only when the statistical source is header.	hello
StatusCode	object	The status code.
Enabled	boolean	Indicates whether the feature is enabled. Valid values: true: enabled false: disabled	true
Code	integer	The status code. Valid values: 100 to 599: 200: indicates success Others: indicate error codes	200
UseRatio	boolean	Indicates whether to use a ratio: true: uses a ratio false: does not use a ratio	true
CountThreshold	integer	When a ratio is not used, the handling action is triggered only when the corresponding status code reaches CountThreshold. Valid values: 2 to 50000.	10
RatioThreshold	integer	When a ratio is used, the handling action is triggered only when the corresponding status code reaches RatioThreshold. Valid values: 1 to 100.	10

Examples

Success response

JSON format

{
  "RequestId": "CF33B4C3-196E-4015-AADD-5CAD00057B80",
  "TotalCount": "12",
  "Domain": "www.aliyun.com",
  "WebCCRules": [
    {
      "Owner": "manual",
      "Expires": 0,
      "Name": "wq",
      "RuleDetail": {
        "Mode": "废弃",
        "Count": 0,
        "Name": "ccauto14",
        "Action": "block",
        "Interval": 60,
        "Ttl": 300,
        "Uri": "/p3shijihao",
        "RateLimit": {
          "SubKey": "action",
          "Interval": 60,
          "Threshold": 20,
          "Ttl": 15,
          "Target": "ip"
        },
        "Condition": [
          {
            "MatchMethod": "belong",
            "Field": "ip",
            "HeaderName": "null",
            "Content": "192.0.XX.XX",
            "ContentList": "[\"2\",\"3\",\"ad\"]"
          }
        ],
        "Statistics": {
          "Mode": "count",
          "Field": "uri",
          "HeaderName": "hello"
        },
        "StatusCode": {
          "Enabled": true,
          "Code": 200,
          "UseRatio": true,
          "CountThreshold": 10,
          "RatioThreshold": 10
        }
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.