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


1. API Description

Domain name for API request:

This API (DescribeOverviewStatistics) is used to get the overview 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: DescribeOverviewStatistics.
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.

3. Output Parameters

Parameter Name Type Description
OnlineMachineNum Integer Number of online servers.
ProVersionMachineNum Integer Number of servers with HS Pro activated.
MalwareNum Integer Number of Trojan files.
NonlocalLoginNum Integer Number of remote logins.
BruteAttackSuccessNum Integer Number of successful brute force attacks.
VulNum Integer Number of vulnerabilities.
BaseLineNum Integer Number of security baselines.
RequestId String The unique ID of a request, which is required for each troubleshooting case.

4. Example

Example 1 Get the overview statistics

Input example
&<Common request parameters>

Output example

  "Response": {
    "OnlineMachineNum": 1,
    "MalwareNum": 1,
    "ProVersionMachineNum": 1,
    "BaseLineNum": 1,
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "NonlocalLoginNum": 1,
    "BruteAttackSuccessNum": 1,
    "VulNum": 1

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.

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.InvalidFormat Incorrect parameter format.
MissingParameter A parameter is missing.