DescribeVulEffectHostList

Download PDF

DescribeVulEffectHostList

Last updated: 2024-08-27 11:37:00

Download PDF

1. API Description

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

This API is used to obtain the list of hosts affected by vulnerabilities.

A maximum of 10 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: DescribeVulEffectHostList.
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 limit, with the maximum value being 100.
Offset	Yes	Integer	Pagination offset
VulId	Yes	Integer	Vulnerability ID
Filters.N	No	Array of Filter	Filter criteria: AliasName - String - host name for filtering TagIds - String - array of host tag IDs separated by commas Status - String - status: 0: pending; 1: ignored; 3: fixed; 5: detecting; 6: fixing; 8: fixing failed Uuid - String array - UUID 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 non-Tencent Cloud machines and offline client)

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of lists
VulEffectHostList	Array of VulEffectHostList	List of affected hosts 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 List of Hosts Affected by Vulnerability

List of hosts affected by the vulnerability

Input Example

https://cwp.tencentcloudapi.com/?Action=DescribeVulEffectHostList
&VulId=100435
&Limit=10
&Offset=0
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "4234234",
        "TotalCount": 2,
        "VulEffectHostList": [
            {
                "EventId": 15,
                "Status": 0,
                "LastTime": "2020-04-22 03:29:52",
                "Level": 1,
                "Quuid": "b86925b4-cc36-420e-80d4-5094cb2f094b",
                "Uuid": "ed629672-165e-11ea-8bcf-40f2e9f3d932",
                "HostIp": "10.104.14.165",
                "AliasName": "POC test (129.204.36.227)",
                "Tags": null
            },
            {
                "EventId": 16,
                "Status": 1,
                "LastTime": "2020-02-09 03:02:17",
                "Level": 2,
                "Quuid": "b86925b4-cc36-420e-80d4-5094cb2f094b",
                "Uuid": "ed629672-165e-11ea-8bcf-40f2e9f3d932",
                "HostIp": "10.104.14.165",
                "AliasName": "POC test (129.204.36.227)",
                "Tags": null
            }
        ]
    }
}

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

Tencent Cloud CLI 3.0

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.InvalidFormat	Incorrect parameter format.
InvalidParameter.MissingParameter	Missing parameter.
InvalidParameter.ParsingError	Incorrect parameter parsing.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Missing parameter error.

tencent cloud

Recent Pages

DescribeVulEffectHostList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 List of Hosts Affected by Vulnerability

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeVulEffectHostList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 List of Hosts Affected by Vulnerability

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?