tencent cloud

文档反馈

DescribeSecurityEventsCnt

最后更新时间:2024-12-06 15:40:18

1. API Description

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

This API is used to obtain the statistics data of security overview-related events.

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: DescribeSecurityEventsCnt.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
Malware SecurityEventInfo Trojan file-related risk event
HostLogin SecurityEventInfo Log-in audit-related risk event
BruteAttack SecurityEventInfo Password cracking-related risk event
RiskDns SecurityEventInfo Malicious request-related risk event
Bash SecurityEventInfo High-risk command-related risk event
PrivilegeRules SecurityEventInfo Local privilege escalation-related risk event
ReverseShell SecurityEventInfo Reverse Shell-related risk event
SysVul SecurityEventInfo Application vulnerability-related risk event
WebVul SecurityEventInfo Web application vulnerability-related risk event
EmergencyVul SecurityEventInfo Emergency vulnerability-related risk event
BaseLine SecurityEventInfo Security baseline-related risk event
AttackLogs SecurityEventInfo Attack detection-related risk event
EffectMachineCount Integer Number of affected machines
EventsCount Integer Total of number of events
WindowVul SecurityEventInfo Total of Windows system vulnerability events
Note: This field may return null, indicating that no valid values can be obtained.
LinuxVul SecurityEventInfo Total of Linux system vulnerability 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.

4. Example

Example1 Obtaining Statistics Data on Security Events

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

Input Example

https://cwp.intl.tencentcloudapi.com/?Action=DescribeSecurityEventsCnt
&<Common request parameters>

Output Example

{
    "Response": {
        "Malware": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "EventsCount": 1,
        "ReverseShell": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "BaseLine": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "BruteAttack": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "EffectMachineCount": 1,
        "EmergencyVul": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "SysVul": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "PrivilegeRules": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "RiskDns": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "HostLogin": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "RequestId": "06eea0c1-7f08-41ba-a75e-8b2500e16bdf ",
        "AttackLogs": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "WindowVul": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "LinuxVul": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "Bash": {
            "EventCnt": 1,
            "UuidCnt": 1
        },
        "WebVul": {
            "EventCnt": 1,
            "UuidCnt": 1
        }
    }
}

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
InternalError.MainDBFail Failed to manipulate the data.
InvalidParameter Incorrect parameter.
ResourceNotFound The resource does not exist.