Help & DocumentationCloud Workload ProtectionAPI documentationVulnerability Management-Related APIsDescribeVuls

DescribeVuls

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

PDF

Contents：

1. API Description

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

This API (DescribeVuls) is used to get the list of vulnerabilities.

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: DescribeVuls.
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.
VulType Yes String Vulnerability type.
  • WEB: Web application vulnerability
  • SYSTEM: System component vulnerability
  • BASELINE: Security baseline
    		•
    Limit No Integer Number of returned results. It defaults to 10. The maximum is 100.
    Offset No Integer Offset. It defaults to 0.
    Filters.N No Array of Filter Filter.
  • Status - String - Required: No - Filter by status (UN_OPERATED: Pending | FIXED: Fixed)

    Only one value is allowed for the status filter. "OR" relationship is not supported.
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of vulnerabilities.
    Vuls Array of Vul Array of vulnerabilities.
    RequestId String The unique ID of a request, which is required for each troubleshooting case.

    4. Example

    Example 1 Get the list of vulnerabilities

    Input example

    https://yunjing.tencentcloudapi.com/?Action=DescribeVuls
&VulType=WEB
&Limit=10
&Offset=0
&<Common request parameters>

    Output example

    {
  "Response": {
    "TotalCount": 10,
    "Vuls": [
      {
        "ImpactedHostNum": 10,
        "VulName": "Vulnerability name",
        "LastScanTime": "2018-03-19 17:38:56",
        "VulLevel": "HIGHT",
        "VulStatus": "FIXED",
        "VulId": 4
      }
    ],
    "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.InvalidFormat Incorrect parameter format.
    MissingParameter A parameter is missing.