Last updated: 2019-06-26 20:08:00


1. API Description

Domain name for API request:

This API (DescribeWeeklyReportInfo) is used to obtain the details in the weekly report of HS Pro.

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: DescribeWeeklyReportInfo.
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 of the weekly report of HS Pro.

3. Output Parameters

Parameter Name Type Description
CompanyName String Name of the company or individual to which the account belongs.
MachineNum Integer Number of hosts.
OnlineMachineNum Integer Number of HS clients online.
OfflineMachineNum Integer Number of HS clients offline.
ProVersionMachineNum Integer Number of hosts with HS Pro activated.
BeginDate Date Start time of the weekly report.
EndDate Date End time of the weekly report.
Level String Security level.
  • HIGH: High
  • MIDDLE: Medium
  • LOW: Low
  • MalwareNum Integer Number of Trojans records.
    NonlocalLoginNum Integer Number of remote logins.
    BruteAttackSuccessNum Integer Number of successful brute force attacks.
    VulNum Integer Number of vulnerabilities.
    RequestId String The unique ID of a request, which is required for each troubleshooting case.

    4. Example

    Example 1 Obtain the details in the weekly report of HS Pro

    Input example
    &<Common request parameters>

    Output example

      "Response": {
        "OnlineMachineNum": 80,
        "EndDate": "2018-10-13",
        "MalwareNum": 11,
        "ProVersionMachineNum": 30,
        "CompanyName": "Component name",
        "BeginDate": "2018-10-08",
        "Level": "LOW",
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "NonlocalLoginNum": 11,
        "BruteAttackSuccessNum": 11,
        "MachineNum": 100,
        "OfflineMachineNum": 20,
        "VulNum": 11

    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.IllegalRequest Invalid request.