tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeWebManagedRulesTopData

Last updated: 2023-03-09 17:41:50

1. API Description

Domain name for API request: teo.tencentcloudapi.com.

This API is used to query the top data of web hosting rules.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeWebManagedRulesTopData.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region No String Common Params. This parameter is not required for this API.
StartTime Yes Timestamp ISO8601 Start time
EndTime Yes Timestamp ISO8601 End time
MetricName Yes String Filter metric
Limit Yes Integer Number of the top data entries to query. 0: queries all data entries.
ZoneIds.N No Array of String Site set
PolicyIds.N No Array of Integer Set of DDoS policy group IDs
Port No Integer Port number
ProtocolType No String Protocol type. Valid values: tcp, udp, all
AttackType No String Attack type. Valid values: flood, icmpFlood..., all
Domains.N No Array of String Domain name set

3. Output Parameters

Parameter Name Type Description
Data Array of TopNEntry Top N data
Status Integer Status. 1: failed; 0: succeeded
Msg String Returned message
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the top N web attack data

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebManagedRulesTopData
<Common request parameters>

{
    "AttackType": "xx",
    "MetricName": "xx",
    "ProtocolType": "xx",
    "PolicyIds": [
        0
    ],
    "ZoneIds": [
        "xx"
    ],
    "Domains": [
        "xx"
    ],
    "Limit": 0,
    "StartTime": "2020-09-22T00:00:00+00:00",
    "EndTime": "2020-09-22T00:00:00+00:00"
}

Output Example

{
    "Response": {
        "Status": 0,
        "Msg": "success",
        "Data": [
            {
                "Value": [
                    {
                        "Count": 123,
                        "Name": "udp"
                    }
                ],
                "Key": "subzoneId2"
            }
        ],
        "RequestId": "xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
LimitExceeded The quota limit has been reached.
ResourceNotFound The resource doesn’t exist.
UnauthorizedOperation.CamUnauthorized CAM is not authorized.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy