1. API Description
Domain name for API request: yunjing.tencentcloudapi.com.
This API is used to get the vulnerability list.
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 parameter. The value used for this API: DescribeVuls. |
| Version |
Yes |
String |
Common parameter. The value used for this API: 2018-02-28. |
| Region |
No |
String |
Common parameter. This parameter is not required for this API. |
| VulType |
Yes |
String |
Vulnerability type. WEB: web application vulnerabilitySYSTEM: system component vulnerabilityBASELINE: security baseline |
| Limit |
No |
Integer |
Number of results to be returned. Default value: 10. Maximum value: 100. |
| Offset |
No |
Integer |
Offset. Default value: 0. |
| Filters.N |
No |
Array of Filter |
Filter. Status - String - Required: No - Filter by status (UN_OPERATED: to be processed, FIXED: fixed)
Only one value is allowed for the Status filter, and "OR" logic is not supported. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
Number of vulnerabilities. |
| Vuls |
Array of Vul |
Vulnerability list array. |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Gets vulnerability list
This example shows you how to get the vulnerability list.
https:
&VulType=WEB
&Limit=10
&Offset=0
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
"Vuls": [
{
"VulId": 4,
"VulName": "Vulnerability name",
"VulLevel": "HIGHT",
"VulStatus": "FIXED",
"LastScanTime": "2018-03-19 17:38:56",
"ImpactedHostNum": 10
}
],
"TotalCount": 10
}
}
5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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.InvalidFormat |
Incorrect parameter format. |
| MissingParameter |
Missing parameter. |