tencent cloud

Feedback

DescribeVulHostTop

Last updated: 2024-08-27 11:36:54

1. API Description

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

This API is used to obtain the list of top server risks.

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: DescribeVulHostTop.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Top Yes Integer Obtain top values: 1-100
VulCategory No Integer 1: web-cms vulnerabilities; 2: application vulnerabilities; 4: Linux software vulnerabilities; 5: Windows system vulnerabilities; 6: emergency vulnerabilities. If it is left blank or set to 0, the total statistics of vulnerabilities 1, 2, 4, and 5 are returned.
IsFollowVul No Integer Whether to count only critical vulnerabilities: 1: only critical vulnerabilities; 0: all vulnerabilities

3. Output Parameters

Parameter Name Type Description
VulHostTopList Array of VulHostTopInfo List of top server risks
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 Obtaining the Top Server Risk List

This example shows you how to obtain the list of top server risks.

Input Example

POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVulHostTop
<Common request parameters>

{
    "Top": "5"
}

Output Example

{
    "Response": {
        "RequestId": "f14ce73f-50d7-4c36-af1d-fc33dae510c4",
        "VulHostTopList": [
            {
                "HostName": "v_lwjlin_centos_Lin",
                "Quuid": "979c93e9-fad9-4a6f-8c7e-325a5b30ac7b",
                "VulLevelList": [
                    {
                        "VulLevel": 2,
                        "VulCount": 616
                    },
                    {
                        "VulLevel": 1,
                        "VulCount": 209
                    },
                    {
                        "VulLevel": 3,
                        "VulCount": 363
                    }
                ],
                "Score": 1188
            },
            {
                "HostName": "Vulnerability alarm temporary test",
                "Quuid": "0d751f60-b0a9-4189-a705-010493a99d8b",
                "VulLevelList": [
                    {
                        "VulLevel": 2,
                        "VulCount": 208
                    },
                    {
                        "VulLevel": 1,
                        "VulCount": 60
                    },
                    {
                        "VulLevel": 3,
                        "VulCount": 136
                    }
                ],
                "Score": 404
            },
            {
                "HostName": "Temporary overview page test",
                "Quuid": "8092a54e-258d-45a1-ae1f-8477ee6d65fa",
                "VulLevelList": [
                    {
                        "VulLevel": 2,
                        "VulCount": 13
                    },
                    {
                        "VulLevel": 1,
                        "VulCount": 4
                    },
                    {
                        "VulLevel": 3,
                        "VulCount": 9
                    }
                ],
                "Score": 26
            },
            {
                "HostName": "Deliver to colleagues for use__v_lwjlin",
                "Quuid": "928604de-876d-4c56-9914-6f53361944a5",
                "VulLevelList": [
                    {
                        "VulLevel": 2,
                        "VulCount": 13
                    },
                    {
                        "VulLevel": 1,
                        "VulCount": 4
                    },
                    {
                        "VulLevel": 3,
                        "VulCount": 9
                    }
                ],
                "Score": 26
            },
            {
                "HostName": "Temporary overview page test",
                "Quuid": "a231448a-f7a5-4196-8a7e-30f5f6e9187e",
                "VulLevelList": [
                    {
                        "VulLevel": 2,
                        "VulCount": 13
                    },
                    {
                        "VulLevel": 1,
                        "VulCount": 3
                    },
                    {
                        "VulLevel": 3,
                        "VulCount": 9
                    }
                ],
                "Score": 25
            }
        ]
    }
}

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