DescribeVulList

Last Updated At: 2026-08-02 00:05:05

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

This API is used to query the vulnerability list.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-06-14 18:26:56.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeVulList
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
By No No String Field for sorting. Valid values: Level, LastTime, and HostCount.
Example: Level
Filters No No Array of Filters Filtering conditions. 
  • Status - String - required: no - processing status.  0 - pending processing; 1 - allowlisted; 2 - deleted; 3 - fixed; 5 - detecting; 6 - fixing; 8 - fixing failed.
  • ModifyTime - String - required: no - last occurrence time.
  • Uuid- String - required: no - Query by host UUID.
  • VulName- String -
  • VulCategory- String - required: no - vulnerability category. 1: Web-CMS vulnerability; 2: application vulnerability; 4: Linux software vulnerability; 5: Windows system vulnerability.
  • IsSupportDefense - int- required: no - whether defense is supported. 0: not supported; 1: supported.
  • Labels- string- required: no - search by tag.
  • IsSupportAutoFix- string- required: no - whether automatic fixing is supported. 0: not supported; 1: supported.
  • CvssScore- string- required: no - lower limit of CVSS score.
  • AttackLevel- string- required: no - lower limit of attack level.

  • Example:View
    Limit No No Uint64 Maximum number of entries to return. Maximum value: 100.
    Example: 10
    Offset No No Uint64 Offset. Default value: 0.
    Example: 0
    Order No No String Sorting order. Valid values: asc and desc. Default value: asc.
    Example: desc

    3. Output Parameters

    Parameter name Type Description
    FollowVulCount Uint64 Number of critical vulnerabilities.
    Example: 23
    TotalCount Uint64 Total number of vulnerabilities.
    Example: 1
    VulInfoList Array of VulInfoList Vulnerability list.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InternalError Internal error.
    InvalidParameter.ParsingError Parameter parsing error.
    InvalidParameter.MissingParameter Missing parameter.
    MissingParameter Missing parameter.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.