1. API Description
Domain name for API request: cwp.intl.tencentcloudapi.com.
This API is used to obtain the statistics of security 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.
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: DescribeSecurityEventStat. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2018-02-28. |
| Region |
No |
String |
Common Params. This parameter is not required. |
| Filters.N |
No |
Array of Filter |
This API has no filtering criteria. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| MalwareStat |
EventStat |
Trojan event statistics |
| HostLoginStat |
EventStat |
Statistics of cross-region log-in events |
| BruteAttackStat |
EventStat |
Statistics of brute force cracking events |
| MaliciousRequestStat |
EventStat |
Malicious request event statistics |
| PrivilegeStat |
EventStat |
Statistics of local privilege escalation events |
| ReverseShellStat |
EventStat |
Reverse shell event statistics |
| HighRiskBashStat |
EventStat |
Statistics of high-risk command events |
| AttackLogsStat |
EventStat |
Network attack event statistics |
| VulHighStat |
EventStat |
Statistics of high-risk vulnerability events |
| VulNormalStat |
EventStat |
Statistics of medium-risk vulnerability events |
| VulLowStat |
EventStat |
Statistics of low-risk vulnerability events |
| BaselineHighStat |
EventStat |
Statistics of high-risk baseline vulnerability events |
| BaselineNormalStat |
EventStat |
Statistics of medium-risk baseline vulnerability events |
| BaselineLowStat |
EventStat |
Statistics of low-risk baseline vulnerability events |
| MachineTotalAffectNum |
Integer |
Total number of machines with unfixed security events |
| InvasionTotalAffectNum |
Integer |
Total number of machines with unfixed intrusion security events |
| VulTotalAffectNum |
Integer |
Total number of machines with unfixed vulnerability security events |
| BaseLineTotalAffectNum |
Integer |
Total number of machines with unfixed baseline security events |
| CyberAttackTotalAffectNum |
Integer |
Total number of machines with unfixed network attack security events |
| VulRiskStat |
EventStat |
Critical vulnerability event statistics |
| BaselineRiskStat |
EventStat |
Statistics of critical baseline vulnerability events |
| VulStat |
EventStat |
Statistics on the number of vulnerabilities |
| Score |
Integer |
Security score |
| 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 the Security Event Statistics Data
https:
&<Common request parameters>
Output Example
{
"Response": {
"MachineTotalAffectNum": 28,
"InvasionTotalAffectNum": 22,
"VulTotalAffectNum": 5,
"BaseLineTotalAffectNum": 5,
"CyberAttackTotalAffectNum": 0,
"MalwareStat": {
"EventsNum": 352,
"MachineAffectNum": 9
},
"HostLoginStat": {
"EventsNum": 57,
"MachineAffectNum": 10
},
"BruteAttackStat": {
"EventsNum": 5,
"MachineAffectNum": 3
},
"MaliciousRequestStat": {
"EventsNum": 20,
"MachineAffectNum": 4
},
"PrivilegeStat": {
"EventsNum": 32,
"MachineAffectNum": 5
},
"ReverseShellStat": {
"EventsNum": 2,
"MachineAffectNum": 1
},
"HighRiskBashStat": {
"EventsNum": 179,
"MachineAffectNum": 8
},
"AttackLogsStat": {
"EventsNum": 0,
"MachineAffectNum": 0
},
"VulRiskStat": {
"EventsNum": 3,
"MachineAffectNum": 2
},
"VulHighStat": {
"EventsNum": 18,
"MachineAffectNum": 5
},
"VulNormalStat": {
"EventsNum": 13,
"MachineAffectNum": 4
},
"VulLowStat": {
"EventsNum": 1,
"MachineAffectNum": 1
},
"BaselineRiskStat": {
"EventsNum": 0,
"MachineAffectNum": 0
},
"BaselineHighStat": {
"EventsNum": 107,
"MachineAffectNum": 5
},
"BaselineNormalStat": {
"EventsNum": 653,
"MachineAffectNum": 5
},
"BaselineLowStat": {
"EventsNum": 128,
"MachineAffectNum": 5
},
"VulStat": {
"EventsNum": 8,
"MachineAffectNum": 5
},
"Score": 20,
"RequestId": "8c952399-b255-3711-1c3c-a5c8a6befbd8"
}
}
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 |
| ResourceNotFound |
The resource does not exist. |