Tencent Cloud

Download PDF

DescribeVulList

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

Download PDF

1. API Description

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

This API is used to obtain the data of 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.

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: DescribeVulList.
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	No	Integer	Number of returns, with the maximum value being 100.
Offset	No	Integer	Offset, which defaults to 0
Filters.N	No	Array of Filters	Filter criteria Status - String - required: no - processing status: 0: pending; 1: allowlisted; 2: deleted; 3: ignored ModifyTime - String - required: no - last occurrence time Uuid- String - required: no - query by host UUID VulName- string - VulCategory- string - required: no - vulnerability category: 1: web CMS vulnerability; 2: application vulnerability; 4: Linux software vulnerability; 5: Windows system vulnerability IsSupportDefense - int - required: no - support for defense: 0: not supported; 1: supported Labels - string - required: no - tag for search IsSupportAutoFix - string - required: no - whether automatic fixing is supported: 0: not supported; 1: supported CvssScore - string - required: no - lower limit of CVSS score AttackLevel - string - required: no - lower limit of attack level
By	No	String	Sorting field: Level, LastTime, and HostCount
Order	No	String	Sorting order: desc and asc. Default value: asc.

3. Output Parameters

Parameter Name	Type	Description
VulInfoList	Array of VulInfoList	Vulnerability list Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total number of vulnerabilities Note: This field may return null, indicating that no valid values can be obtained.
FollowVulCount	Integer	Total number of focused 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 Obtaining the List of Vulnerabilities of Specified Categories and Statuses

This example shows you how to obtain the list of vulnerabilities of specified categories and statuses.

Input Example

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

Output Example

{
    "Response": {
        "VulInfoList": [
            {
                "Ids": "abc",
                "Name": "abc",
                "Status": 1,
                "VulId": 1,
                "PublishTime": "abc",
                "LastTime": "abc",
                "HostCount": 1,
                "Level": 1,
                "From": 1,
                "Descript": "abc",
                "PublishTimeWisteria": "abc",
                "NameWisteria": "abc",
                "DescriptWisteria": "abc",
                "StatusStr": "abc",
                "CveId": "abc",
                "CvssScore": 0,
                "Labels": "abc",
                "FixSwitch": 1,
                "TaskId": 1,
                "IsSupportDefense": 1,
                "DefenseAttackCount": 1,
                "FirstAppearTime": "abc",
                "VulCategory": 1,
                "AttackLevel": 1,
                "FixNoNeedRestart": true
            }
        ],
        "TotalCount": 1,
        "FollowVulCount": 1,
        "RequestId": "abc"
    }
}

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

tencent cloud

Recent Pages

DescribeVulList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Obtaining the List of Vulnerabilities of Specified Categories and Statuses

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

DescribeVulList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Obtaining the List of Vulnerabilities of Specified Categories and Statuses

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?