Tenant Cloud Security Cloud Workload Protection Platform Vulnerability Management APIs DescribeVulEffectHostList

DescribeVulEffectHostList

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

1. Interface Description

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

API for querying servers affected by vulnerabilities

Default interface request rate limit: 20 times per second.

Interface update time: 2022-07-25 15:56:07.

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: DescribeVulEffectHostList
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.
Filters No No Array of Filter Filter conditions.
  • AliasName - String - Host name for filtering.
  • IP - String - Host IP address for filtering.
  • InstanceID - String - Host instance ID for filtering.
  • TagIds - String - Array of host tag IDs separated by commas.
  • Status - String - Status. 0: to be handled; 1: ignored; 3: fixed; 5: detecting; 6: fixing; 8: fixing failed.
  • Uuid - String array - UUID string array.
  • Version - String array - Paid edition array. "Flagship": Ultimate Edition; "PRO_Version": Pro Edition; "BASIC_Version": Basic Edition.
  • InstanceState - String array - Instance Status array. "PENDING": creating; "LAUNCH_FAILED": creation failed; "RUNNING": running; "STOPPED": shut down; "STARTING": starting; "STOPPING": shutting down; "REBOOTING": restarting; "SHUTDOWN": to be terminated; "TERMINATING": terminating; "UNKNOWN": unknown (for scenarios with non-cloud servers and offline client).

    • Example:View
    Limit Yes No Uint64 Maximum number of entries to return on each page. Maximum value: 100.
    Example: 10
    Offset Yes No Uint64 The offset for paging.
    Example: 0
    VulId Yes No Uint64 Vulnerability ID.
    Example: 1

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Total number of servers in the list.
    Example: 1
    VulEffectHostList Array of VulEffectHostList List of affected servers.
    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.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    MissingParameter Missing parameter.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.