DescribeWebCCRules - Anti-DDoS - Alibaba Cloud Documentation Center

This API is deprecated. You are advised to use ddoscoo(2020-01-01) - ConfigWebCCRuleV2.

Queries the custom frequency control rules that are created for a website.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeWebCCRules	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.	default
Domain	string	Yes	The domain name of the website. Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query all domain names.	www.aliyun.com
PageNumber	integer	No	The number of the page to return. For example, to query the returned results on the first page, set the value to 1.	1
PageSize	string	Yes	The number of entries to return on each page.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of custom frequency control rules.	1
RequestId	string	The request ID.	EAED912D-909E-45F0-AF74-AC0CCDCAE314
WebCCRules	array<object>	The custom frequency control rule.
WebCCRule	object
Ttl	integer	The validity period. Valid values: 1 to 1440. Unit: minutes.	60
Act	string	The action triggered if the rule is matched. Valid values: close: The requests that match the rule are blocked. captcha: Completely Automated Public Turing test to tell Computers and Humans Apart (CAPTCHA) verification for the requests that match the rule is implemented.	close
Interval	integer	The check interval. Valid values: 5 to 10800. Unit: seconds.	5
Mode	string	The match mode. Valid values: prefix: prefix match. match: exact match.	prefix
Name	string	The name of the rule.	wq
Uri	string	The check path.	/hello
Count	integer	The number of requests that are allowed from a single IP address. Valid values: 2 to 2000.	3

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "EAED912D-909E-45F0-AF74-AC0CCDCAE314",
  "WebCCRules": [
    {
      "Ttl": 60,
      "Act": "close",
      "Interval": 5,
      "Mode": "prefix",
      "Name": "wq",
      "Uri": "/hello",
      "Count": 3
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-06-25	The API operation is deprecated	View Change Details