tencent cloud

Feedback

DescribeWebProtectionData

Last updated: 2022-09-01 15:05:35

1. API Description

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.

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: DescribeWebProtectionData.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
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}

3. Output Parameters

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.

4. Example

Example1 Querying the web attack data

Input Example

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"
}

Output Example

{
    "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"
    }
}

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.
ResourceNotFound The resource doesn’t exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support