tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeBotTopData

最后更新时间：2022-11-28 16:50:43
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to query the top-ranked bot attack data.

A maximum of 100 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: DescribeBotTopData.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
StartTime Yes Timestamp ISO8601 The start time.
EndTime Yes Timestamp ISO8601 The end time.
MetricName Yes String List of statistical metric. Values:
  • bot_requestNum_labelType: Top-ranked tag types by bot requests.
  • bot_requestNum_url: Top-ranked URLs by bot requests.
  • bot_cipRequestNum_region: Top-ranked client IPs by bot requests.
    		•
    ZoneIds.N No Array of String List of sites to be queried. All sites will be selected if this field is not specified.
    Domains.N No Array of String List of subdomain names to be queried. All subdomain names will be selected if this field is not specified.
    Limit No Integer Queries the top rows of data. Maximum value: 1000. Top 10 rows of data will be queried if this field is not specified.
    Interval No String The query time granularity. Values:
  • min: 1 minute;
  • 5min: 5 minute;
  • hour: 1 hour;
  • day: 1 day.
    • If this field is not specified, the granularity will be determined based on the interval between the start time and end time as follows: 1-minute granularity applies for a 1-hour interval, 5-minute granularity for a 2-day interval, 1-hour granularity for a 7-day interval, and 1-day granularity for an interval of over 7 days.
    QueryCondition.N No Array of QueryCondition The key of the parameter QueryCondition, which is used to specify a filter. Values:
  • action: The action;
    		•
    Area No String Data storage region. Values:
  • overseas: Global (outside the Chinese mainland);
  • mainland: Chinese mainland.
    • If this field is not specified, the data storage region will be determined based on the user’s location.

    3. Output Parameters

    Parameter Name Type Description
    Data Array of TopEntry The list of top-ranked bot attack data.
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of query results.
    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-ranked bot attack data

    Input Example

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

{
    "QueryCondition": [
        {
            "Operator": "equlas",
            "Value": [
                "drop"
            ],
            "Key": "action"
        }
    ],
    "Interval": "min",
    "ZoneIds": [
        "zone-21xfqlh4qjee"
    ],
    "Limit": 10,
    "StartTime": "2020-09-22T00:00:00+00:00",
    "Domains": [
        "www.baidu.com"
    ],
    "EndTime": "2020-09-22T00:00:00+00:00",
    "MetricName": "bot_cipRequestNum_region",
    "Area": "overseas"
}

    Output Example

    {
    "Response": {
        "TotalCount": 20,
        "Data": [
            {
                "Value": [
                    {
                        "Count": 123,
                        "Name": "CN"
                    }
                ],
                "Key": "www.baidu.com"
            }
        ],
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a707"
    }
}

    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.
    InternalError.ProxyServer An unknown error occurred in the backend server.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款