Tenant Cloud Security Cloud Workload Protection Platform Baseline Management APIs DescribeBaselineEffectHostList

DescribeBaselineEffectHostList

Last Updated At: 2026-08-02 00:04:59

1. Interface Description

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

This API is used to query the servers affected by a baseline based on a baseline ID.

Default interface request rate limit: 20 times per second.

Interface update time: 2023-03-28 01:21: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: DescribeBaselineEffectHostList
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.
BaselineId Yes No Uint64 Baseline ID.
Example: 12
Filters No No Array of Filters Filter condition.
  • AliasName - String - Server alias.
  • Status - Uint - 1: passed. 0: not passed. 5: checking.

    • 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 number of the page to be returned.
    Example: 0
    StrategyId No No Uint64 Policy ID.
    Example: 1124
    UuidList No No Array of String Server UUIDs.
    Example: ["5a540076-d38a-4078-aa98-qwert371d322"]

    3. Output Parameters

    Parameter name Type Description
    EffectHostList Array of BaselineEffectHost List of affected servers.
    Example:View
    TotalCount Uint64 Total number of records.
    Example: 12
    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.IllegalRequest Invalid request.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is invalid.