tencent cloud

Feedback

DescribeSecurityTrends

Last updated: 2024-08-27 11:33:27

    1. API Description

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

    This API is used to obtain the security event statistics 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: DescribeSecurityTrends.
    Version Yes String Common Params. The value used for this API: 2018-02-28.
    Region No String Common Params. This parameter is not required.
    BeginDate Yes Date Start time. Example: 2021-07-10
    EndDate Yes Date End time. Example: 2021-07-10

    3. Output Parameters

    Parameter Name Type Description
    Malwares Array of SecurityTrend Array of counted Trojan events
    NonLocalLoginPlaces Array of SecurityTrend Array of counted cross-region log-in events
    BruteAttacks Array of SecurityTrend Array of counted password cracking events
    Vuls Array of SecurityTrend Array of counted vulnerabilities
    BaseLines Array of SecurityTrend Array of counted baselines
    MaliciousRequests Array of SecurityTrend Array of counted malicious requests
    HighRiskBashs Array of SecurityTrend Array of counted high-risk command
    ReverseShells Array of SecurityTrend Array of counted reverse shell
    PrivilegeEscalations Array of SecurityTrend Array of counted local privilege escalation
    CyberAttacks Array of SecurityTrend Array of counted network attacks
    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.

    4. Example

    Example1 Obtaining Statistics Data on Security Events

    This example shows you how to obtain statistics data on security events.

    Input Example

    POST / HTTP/1.1
    Host: cwp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeSecurityTrends
    <Common request parameters>
    
    {
        "BeginDate": "2020-06-20",
        "EndDate": "2020-06-22"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "64643b63-303d-e52c-d262-38222e7dba8f"
        }
    }
    

    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
    InternalError Internal error
    InvalidParameter Incorrect parameter.
    InvalidParameter.DateRange Incorrect time range format.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.