DescribeSecurityTrends

Last updated: 2019-06-26 20:07:58

1. API Description

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

This API (DescribeSecurityTrends) is used to get the security event statistics.

Default request rate limit: 20/sec.

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 parameter. The value​used for this API: DescribeSecurityTrends.
Version Yes String Common parameter. The value used for this API: 2/28/2018
Region No String Common parameter. This parameter is not required for this API.
BeginDate Yes Date Start time.
EndDate Yes Date End time.

3. Output Parameters

Parameter Name Type Description
Malwares Array of SecurityTrend Array of Trojan event statistics.
NonLocalLoginPlaces Array of SecurityTrend Array of remote login event statistics.
BruteAttacks Array of SecurityTrend Array of brute force attack event statistics.
Vuls Array of SecurityTrend Array of vulnerability statistics.
BaseLines Array of SecurityTrend Array of baseline statistics.
RequestId String The unique ID of a request, which is required for each troubleshooting case.

4. Example

Example 1 Get security event statistics

Input example

https://yunjing.tencentcloudapi.com/?Action=DescribeSecurityTrends
&BeginDate=2018-10-08
&EndDate=2018-10-10
&<Common request parameters>

Output example

{
  "Response": {
    "NonLocalLoginPlaces": [
      {
        "Date": "2018-10-08",
        "EventNum": 1
      },
      {
        "Date": "2018-10-09",
        "EventNum": 2
      },
      {
        "Date": "2018-10-10",
        "EventNum": 3
      }
    ],
    "Vuls": [
      {
        "Date": "2018-10-08",
        "EventNum": 1
      },
      {
        "Date": "2018-10-09",
        "EventNum": 2
      },
      {
        "Date": "2018-10-10",
        "EventNum": 3
      }
    ],
    "Malwares": [
      {
        "Date": "2018-10-08",
        "EventNum": 1
      },
      {
        "Date": "2018-10-09",
        "EventNum": 2
      },
      {
        "Date": "2018-10-10",
        "EventNum": 3
      }
    ],
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "BruteAttacks": [
      {
        "Date": "2018-10-08",
        "EventNum": 1
      },
      {
        "Date": "2018-10-09",
        "EventNum": 2
      },
      {
        "Date": "2018-10-10",
        "EventNum": 3
      }
    ],
    "BaseLines": [
      {
        "Date": "2018-10-08",
        "EventNum": 1
      },
      {
        "Date": "2018-10-09",
        "EventNum": 2
      },
      {
        "Date": "2018-10-10",
        "EventNum": 3
      }
    ]
  }
}

5. Resources for Developers

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using cloud APIs.

SDK

Cloud API 3.0 comes with the software development kit (SDK) that supports multiple programming languages and makes it easier to call the APIs.

Command line tools

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter.DateRange Invalid time range format.
InvalidParameter.IllegalRequest Invalid request.
InvalidParameter.InvalidFormat Incorrect parameter format.