1. API Description
Domain name for API request: cwp.intl.tencentcloudapi.com.
This API is used to count top vulnerabilities.
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.
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: DescribeVulTop. |
| 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 |
Top servers by vulnerability risks. The specific number is in the range of 1 to 100. |
| VulCategory |
No |
Integer |
1: web CMS vulnerability; 2: application vulnerability; 4: Linux software vulnerability; 5: Windows system vulnerability; 6: emergency vulnerability. If this parameter is left blank or set to 0, the statistical data of all these types of vulnerabilities is returned. |
| IsFollowVul |
No |
Integer |
Whether to count only focused vulnerabilities. 1: count only focused vulnerabilities; 0: count all vulnerabilities. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| VulTopList |
Array of VulTopInfo |
List of top vulnerabilities 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 Top Vulnerability Statistics
This example shows you the top vulnerability statistics.
POST / HTTP/1.1
Host: cwp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVulTop
<Common request parameters>
{
"Top": "5"
}
Output Example
{
"Response": {
"RequestId": "f14ce73f-50d7-4c36-af1d-fc33dae510c4",
"VulTopList": [
{
"VulName": "Maximum validity days policy of the account after Linux password expires",
"VulLevel": 1,
"VulCount": 27
},
{
"VulName": "Linux does not configure account log-in failure lock policy.",
"VulLevel": 2,
"VulCount": 17
},
{
"VulName": "Linux account timeout auto-logout configuration",
"VulLevel": 2,
"VulCount": 17
},
{
"VulName": "Linux account password lifetime policy",
"VulLevel": 2,
"VulCount": 17
},
{
"VulName": "Restrict remote log-in of users with root permission.",
"VulLevel": 2,
"VulCount": 17
}
]
}
}
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. |