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


1. API Description

Domain name for API request:

This API (DescribeWeeklyReportVuls) is used to obtain the vulnerability data 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: DescribeWeeklyReportVuls.
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.
Limit No Integer Number of returned results. It defaults to 10. The maximum is 100.
Offset No Integer Offset. It defaults to 0.

3. Output Parameters

Parameter Name Type Description
WeeklyReportVuls Array of WeeklyReportVul Array of vulnerability data in the weekly report of HS Pro.
TotalCount Integer Total number of records.
RequestId String The unique ID of a request, which is required for each troubleshooting case.

4. Example

Example 1 Obtain the vulnerability data in the weekly report of HS Pro

Input example
&<Common request parameters>

Output example

  "Response": {
    "TotalCount": 100,
    "WeeklyReportVuls": [
        "Description": "Vulnerability description",
        "VulType": "WEB",
        "VulName": "Vulnerability name",
        "LastScanTime": "2018-10-11 12:23:22",
        "VulStatus": "FIXED",
        "MachineIp": ""
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"

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.
InvalidParameter.InvalidFormat Incorrect parameter format.