tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeIgnoreRuleEffectHostList

Last updated: 2024-08-27 11:42:55

1. API Description

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

This API is used to query the information on the list of hosts affected by ignored detection items based on detection item IDs and filter criteria.

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: DescribeIgnoreRuleEffectHostList.
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 quantity is 100)
Offset Yes Integer Pagination parameter
RuleId Yes Integer Detection Item ID
Filters.N No Array of Filters Filter criteria
  • AliasName - String - host alias
    		•
    TagNames.N No Array of String Host tag name

    3. Output Parameters

    Parameter Name Type Description
    IgnoreRuleEffectHostList Array of IgnoreRuleEffectHostInfo List of hosts affected by ignored check items
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of records for paging query
    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 Obtaining the List of Hosts Affected by Ignored Check Items

    This example shows you how to obtain the list of hosts affected by ignored check items based on check item ID.

    Input Example

    https://cwp.tencentcloudapi.com/?Action=DescribeIgnoreRuleEffectHostList
&Limit=10
&Offset=0
&RuleId=1
&TagNames.0=tag
&<Common request parameters>

    Output Example

    {
    "Response": {
        "IgnoreRuleEffectHostList": [
            {
                "HostName": "Test host 3",
                "Level": "1",
                "TagList": [
                    "Exhibition"
                ],
                "Status": 1,
                "LastScanTime": "2020-06-16 09:13:54",
                "EventId": 666,
                "Quuid": "23220"
            },
            {
                "HostName": "Test host 3",
                "Level": "3",
                "TagList": [
                    "Exhibition"
                ],
                "Status": 1,
                "LastScanTime": "2020-06-16 09:13:54",
                "EventId": 666,
                "Quuid": "23220"
            }
        ],
        "RequestId": "f1dd9f5e-4ac0-48a7-9410-c86d24656d9a",
        "TotalCount": 2
    }
}

    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