DescribeSecurityTrends

Last updated: 2020-09-11 10:41:07

1. API Description

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

This API is used to get the security event statistics.

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 parameter. The value used for this API: DescribeSecurityTrends.
Version Yes String Common parameter. The value used for this API: 2018-02-28.
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 Trojan event statistics array.
NonLocalLoginPlaces Array of SecurityTrend Unusual login location event statistics array.
BruteAttacks Array of SecurityTrend Brute force attack event statistics array.
Vuls Array of SecurityTrend Vulnerability statistics array.
BaseLines Array of SecurityTrend Baseline statistics array.
MaliciousRequests Array of SecurityTrend Statistics array of malicious requests.
HighRiskBashs Array of SecurityTrend Statistics array of high-risk commands.
ReverseShells Array of SecurityTrend Statistics array of reverse shells.
PrivilegeEscalations Array of SecurityTrend Statistics array of local privilege escalations.
CyberAttacks Array of SecurityTrend Statistics array of network attacks.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting security event statistics

This example shows you how to get the statistics of security events.

Input Example

https://yunjing.tencentcloudapi.com/?Action=DescribeSecurityTrends
&BeginDate=2020-06-20
&EndDate=2020-06-22
&<Common request parameters>

Output Example

{
  "Response": {
    "Malware": [
      {
        "Date": "2020-06-20",
        "EventNum": 301
      },
      {
        "Date": "2020-06-21",
        "EventNum": 301
      },
      {
        "Date": "2020-06-22",
        "EventNum": 311
      }
    ],
    "NonLocalLogin": [
      {
        "Date": "2020-06-20",
        "EventNum": 1
      },
      {
        "Date": "2020-06-21",
        "EventNum": 1
      },
      {
        "Date": "2020-06-22",
        "EventNum": 1
      }
    ],
    "BruteattackSuccess": [
      {
        "Date": "2020-06-20",
        "EventNum": 0
      },
      {
        "Date": "2020-06-21",
        "EventNum": 0
      },
      {
        "Date": "2020-06-22",
        "EventNum": 0
      }
    ],
    "Vul": [
      {
        "Date": "2020-06-20",
        "EventNum": 0
      },
      {
        "Date": "2020-06-21",
        "EventNum": 0
      },
      {
        "Date": "2020-06-22",
        "EventNum": 0
      }
    ],
    "Baseline": [
      {
        "Date": "2020-06-20",
        "EventNum": 8
      },
      {
        "Date": "2020-06-21",
        "EventNum": 8
      },
      {
        "Date": "2020-06-22",
        "EventNum": 8
      }
    ],
    "MaliciousRequest": [
      {
        "Date": "2020-06-20",
        "EventNum": 0
      },
      {
        "Date": "2020-06-21",
        "EventNum": 0
      },
      {
        "Date": "2020-06-22",
        "EventNum": 0
      }
    ],
    "HighRiskBash": [
      {
        "Date": "2020-06-20",
        "EventNum": 0
      },
      {
        "Date": "2020-06-21",
        "EventNum": 0
      },
      {
        "Date": "2020-06-22",
        "EventNum": 0
      }
    ],
    "ReverseShell": [
      {
        "Date": "2020-06-20",
        "EventNum": 0
      },
      {
        "Date": "2020-06-21",
        "EventNum": 0
      },
      {
        "Date": "2020-06-22",
        "EventNum": 0
      }
    ],
    "PrivilegeEscalation": [
      {
        "Date": "2020-06-20",
        "EventNum": 0
      },
      {
        "Date": "2020-06-21",
        "EventNum": 0
      },
      {
        "Date": "2020-06-22",
        "EventNum": 0
      }
    ],
    "CyberAttack": [
      {
        "Date": "2020-06-20",
        "EventNum": 0
      },
      {
        "Date": "2020-06-21",
        "EventNum": 0
      },
      {
        "Date": "2020-06-22",
        "EventNum": 0
      }
    ],
    "RequestId": "64643b63-303d-e52c-d262-38222e7dba8f"
  }
}

5. Developer Resources

API Explorer

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

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.DateRange The time range format is incorrect.
InvalidParameter.IllegalRequest Invalid request.
InvalidParameter.InvalidFormat Incorrect parameter format.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help