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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeWebCCRules

The operation that you want to perform. Set the value to DescribeWebCCRules.

Domain String Yes www.aliyun.com

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.
PageSize String Yes 10

The number of entries to return on each page.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
ResourceGroupId String No default

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.

PageNumber Integer No 1

The number of the page to return. For example, to query the returned results on the first page, set the value to 1.

Response parameters

Parameter Type Example Description
RequestId String EAED912D-909E-45F0-AF74-AC0CCDCAE314

The ID of the request.

TotalCount Long 1

The total number of returned custom frequency control rules.

WebCCRules Array

Details about the custom frequency control rule.

Act String close

The blocking type. Valid values:

  • close: Block
  • captcha: Captcha Verification
Count Integer 3

The number of requests that is allowed from an individual IP address. Valid values: 2 to 2000.

Interval Integer 5

The check intervals. Valid values: 5 to 10800. Unit: seconds.

Mode String prefix

The matching mode. Valid values:

  • prefix: Prefix Match
  • match: Exact Match
Name String wq

The name of the custom frequency control rule.

Ttl Integer 60

The blocking duration. Valid values: 1 to 1440. Unit: minutes.

Uri String /hello

The check path.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeWebCCRules
&Domain=www.aliyun.com
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

<DescribeWebCCRulesResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EAED912D-909E-45F0-AF74-AC0CCDCAE314</RequestId>
      <WebCCRules>
            <Act>close</Act>
            <Mode>prefix</Mode>
            <Count>3</Count>
            <Ttl>60</Ttl>
            <Uri>/hello</Uri>
            <Name>wq</Name>
            <Interval>5</Interval>
      </WebCCRules>
</DescribeWebCCRulesResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.