tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBaselineEffectHostList

Last updated: 2024-08-27 11:43:07

1. API Description

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

This API is used to query the list of hosts affected by a baseline based on baseline ID.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: DescribeBaselineEffectHostList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Limit Yes Integer Pagination parameters (The maximum number is 100.)
Offset Yes Integer Pagination parameter
BaselineId Yes Integer Baseline ID
Filters.N No Array of Filters Filter criteria
  • AliasName - String - host alias
  • Status- Uint: 1 - passed; 0 - failed; 5 - under detection
    		•
    StrategyId No Integer Policy ID
    UuidList.N No Array of String Host UUID array

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of records
    Note: This field may return null, indicating that no valid values can be obtained.
    EffectHostList Array of BaselineEffectHost List of affected servers
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying List of Hosts Affected by Baseline

    This example shows you how to query the list of hosts affected by a baseline based on baseline ID.

    Input Example

    https://cwp.tencentcloudapi.com/?Action=DescribeBaselineEffectHostList
&Limit=10
&Offset=0
&BaselineId=100441
&StrategyId=1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "TotalCount": 21,
        "EffectHostList": [
            {
                "PassCount": 100,
                "FailCount": 100,
                "FirstScanTime": "2019-12-25 11:57:15",
                "LastScanTime": "2019-12-25 11:57:15",
                "Status": 0,
                "Quuid": "1c26308c-5493-4eaf-a817-112ec25f499e",
                "HostIp": "xx.xx.xx.xx",
                "AliasName": "Sales license test machine"
            }
        ]
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError Internal error
    InvalidParameter Incorrect parameter.
    InvalidParameter.IllegalRequest Invalid request.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy