Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the web protection data.
A maximum of 20 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: DescribeWebProtectionData. |
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 |
MetricNames.N | Yes | Array of String | List of statistical metrics |
ZoneIds.N | No | Array of String | List of site IDs |
Domains.N | No | Array of String | List of subdomain names |
ProtocolType | No | String | Protocol type |
AttackType | No | String | "webshell" : WebShell detection prevention "oa" : Common OA vulnerability prevention "xss" : XSS attack prevention "xxe" : XXE attack prevention "webscan" : Scanner attack vulnerability prevention "cms" : Common CMS vulnerability prevention "upload" : Malicious file upload attack prevention "sql" : SQL injection attack prevention "cmd_inject": Command/Code injection attack prevention "osc" : Open-source component vulnerability prevention "file_read" : Arbitrary file read prevention "ldap" : LDAP injection attack prevention "other" : Other vulnerability prevention "all":"All" |
Interval | No | String | Query time granularity. Valid values: {min,5min,hour,day} |
Parameter Name | Type | Description |
---|---|---|
Data | Array of SecEntry | Data details Note: This field may return null, indicating that no valid values can be obtained. |
Status | Integer | Status. 1: failed; 0: succeeded |
Msg | String | Message |
Interval | String | Query time granularity. Valid values: {min,5min,hour,day} |
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: DescribeWebProtectionData
<Common request parameters>
{
"AttackType": "xx",
"MetricNames": [
"xx"
],
"ProtocolType": "xx",
"Interval": "xx",
"ZoneIds": [
"xx"
],
"StartTime": "2020-09-22T00:00:00+00:00",
"Domains": [
"xx"
],
"EndTime": "2020-09-22T00:00:00+00:00"
}
{
"Response": {
"Status": 0,
"Msg": "xx",
"Interval": "xx",
"Data": [
{
"Value": [
{
"Max": 0,
"Metric": "xx",
"Avg": 0.0,
"Detail": [
{
"Timestamp": 0,
"Value": 0
}
],
"Sum": 0.0
}
],
"Key": "xx"
}
],
"RequestId": "xx"
}
}
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. |
ResourceNotFound | The resource doesn’t exist. |
Was this page helpful?