DescribeWebCCRulesV2 - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the custom HTTP flood protection (CC protection) rules for website traffic.

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 protected by Alibaba Cloud Anti-DDoS Pro or Anti-DDoS Premium.	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 starting index of the results to return. 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. Alibaba Cloud generates a unique identifier for each request. Use this ID to troubleshoot issues.	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>	Custom HTTP flood protection (CC protection) rules.
	array<object>	Custom HTTP flood protection (CC protection) rules.
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, in seconds. This parameter takes effect only when the action is set to block. During the validity period, access requests are blocked. A value of 0 means the rule is permanently valid.	0
Name	string	The name of the rule.	wq
RuleDetail	object	Details of the rule.
Mode	string	Legacy rule format. Deprecated.	废弃
Count	integer	Legacy rule format. Deprecated.	废弃
Name	string	The name of the rule.	ccauto14
Action	string	The action to take when the rule matches. Valid values: accept: allow block: block challenge: JavaScript Challenge watch: monitor	block
Interval	integer	Legacy rule format. Deprecated.	60
Ttl	integer	Legacy rule format. Deprecated.	300
Uri	string	Legacy rule format. Deprecated.	/p3shijihao
RateLimit	object	Rate limiting settings.
SubKey	string	The header field name. Set this parameter only when Target is set to header.	action
Interval	integer	The statistical period, in seconds.	60
Threshold	integer	The threshold that triggers the action.	20
Ttl	integer	The blocking duration, in seconds.	15
Target	string	The source for statistics. Valid values: ip: count by IP address header: count by HTTP header	ip
Condition	array<object>	A list of matching conditions.
	object	A matching condition.
MatchMethod	string	The matching method.	belong
Field	string	The field to match.	ip
HeaderName	string	The custom HTTP header field name. Note This parameter takes effect only when Field is set to header.	null
Content	string	The content to match.	192.0.XX.XX
ContentList	array	The content to match when MatchMethod is set to match one of multiple values.	["2","3","ad"]
	string		["2","3","ad"]
Statistics	object	Deduplication settings. This parameter is optional. If not specified, deduplication is disabled.
Mode	string	The deduplication mode. Valid values: count: no deduplication distinct: deduplication enabled	count
Field	string	The source for statistics. Valid values: ip: count by IP address header: count by HTTP header uri: count by URI	uri
HeaderName	string	Set this parameter only when Field is set to header.	hello
StatusCode	object	The status code of the rule.
Enabled	boolean	Whether the status code check is enabled. Valid values: true: enabled false: disabled	true
Code	integer	The HTTP status code. Valid values: 100 to 599. 200: success Others: error codes	200
UseRatio	boolean	Whether to use a ratio threshold: true: use ratio false: do not use ratio	true
CountThreshold	integer	If UseRatio is false, the action is triggered only when the number of requests with the specified status code reaches CountThreshold. Valid values: 2 to 50000.	10
RatioThreshold	integer	If UseRatio is true, the action is triggered only when the percentage of requests with the specified 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.