产品动态
产品公告
安全公告
Domain name for API request: waf.intl.tencentcloudapi.com.
This API is used to describe the attack overview.
A maximum of 10 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: DescribeAttackOverview. |
| Version | Yes | String | Common Params. The value used for this API: 2018-01-25. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul, ap-shanghai. |
| FromTime | Yes | Timestamp | Query start time |
| ToTime | Yes | Timestamp | Query end time |
| Appid | No | Integer | Customer app ID |
| Domain | No | String | Queried domain |
| Edition | No | String | Only two values are valid: sparta-waf, clb-waf. No filtering if not input. |
| InstanceID | No | String | WAF instance ID. No filter will be carried out if it is not input. |
| Parameter Name | Type | Description |
|---|---|---|
| AccessCount | Integer | Total number of access requests |
| AttackCount | Integer | Total web attacks |
| ACLCount | Integer | Total number of access controls |
| CCCount | Integer | Total CC attacks |
| BotCount | Integer | Total bot attack count |
| ApiAssetsCount | Integer | Total API assets |
| ApiRiskEventCount | Integer | Number of API risk events Note: This field may return null, indicating that no valid values can be obtained. |
| IPBlackCount | Integer | Total number of blocklisted IP addresses. Note: This field may return null, indicating that no valid values can be obtained. |
| TamperCount | Integer | Total number of tamper-proof items Note: This field may return null, indicating that no valid values can be obtained. |
| LeakCount | Integer | Total number of information leaks Note: This field may return null, indicating that no valid values can be obtained. |
| ApiRiskEventCircleCount | Integer | Weekly proportion of API risk events. Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Obtain the total number of requests within a specified time period. This API does not require a CLS purchase by the customer.
POST / HTTP/1.1
Host: waf.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAttackOverview
<Common request parameters>
{
"FromTime": "2023-02-06 00:00:00",
"ToTime": "2023-02-06 23:59:59"
}{
"Response": {
"AccessCount": 158,
"AttackCount": 98,
"ACLCount": 0,
"CCCount": 0,
"BotCount": 0,
"ApiAssetsCount": 1,
"RequestId": "8a3b7134-77f9-4ee5-b30e-73809ccad10f"
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| FailedOperation.CLSInternalError | CLS internal error. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.InvalidCertificate | Invalid certificate content. |
| InvalidParameter.QueryCertBySSLIDFailed | Failed to query certificate by ID. |
| InvalidParameterValue | Invalid parameter value. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Parameters are missing |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | Too frequent requests |
| ResourceInUse | Resources are occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourceNotFound | Resources do not exist. |
| ResourceUnavailable | Resources are unavailable. |
| ResourcesSoldOut | Resources are sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | The operation is not supported. |
文档反馈