Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the bot attack data recorded over time.
A maximum of 100 requests can be initiated per second for this API.
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: DescribeBotData. |
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. |
MetricNames.N | Yes | Array of String | List of statistical metric. Values:bot_interceptNum : Blocked bot requests;bot_noneRequestNum : Uncategorized bot requests;bot_maliciousRequestNum : Malicious bot requests;bot_suspectedRequestNum : Suspected bot requests;bot_friendlyRequestNum : Friendly bot requests;bot_normalRequestNum : Normal bot requests. |
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. |
ZoneIds.N | No | Array of String | Specifies sites by ID. All sites will be selected 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. |
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. |
Parameter Name | Type | Description |
---|---|---|
Data | Array of SecEntry | The list of 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. |
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBotData
<Common request parameters>
{
"QueryCondition": [
{
"Operator": "equals",
"Value": [
"monitor"
],
"Key": "action"
}
],
"MetricNames": [
"bot_maliciousRequestNu"
],
"Interval": "min",
"ZoneIds": [
"zone-21xfqlh4qjee"
],
"StartTime": "2020-09-22T00:00:00+00:00",
"Domains": [
"www.baidu.com"
],
"EndTime": "2020-09-22T00:00:00+00:00",
"Area": "overseas"
}
{
"Response": {
"TotalCount": 1,
"Data": [
{
"Value": [
{
"Max": 10,
"Metric": "bot_maliciousRequestNu",
"Avg": 10.0,
"Detail": [
{
"Timestamp": 1659456000,
"Value": 10
}
],
"Sum": 10.0
}
],
"Key": "www.baidu.com"
}
],
"RequestId": "1e2fd75a-cdb4-4428-aa70-22c39b5806a1"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
LimitExceeded | The quota limit has been reached. |
OperationDenied | Operation denied. |
ResourceNotFound | The resource doesn’t exist. |
UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
本页内容是否解决了您的问题?