tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeVulStoreList

Last updated: 2024-08-27 11:41:34

1. API Description

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

This API is used to obtain the vulnerability database 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: DescribeVulStoreList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Filters.N No Array of Filter
  • VulName- string - required: no - vulnerability name
  • CveId- string - required: no - cveid
  • VulCategory- string - required: no - vulnerability category: 1: WEB-CMS vulnerabilities; 2: application vulnerabilities; 4: Linux software vulnerabilities; 5: Windows system vulnerabilities
  • Method- string - required: no - detection method: 0: version comparison; 1: POC detection
  • SupportDefense - string - required: no - whether the defense is supported: 0: no; 1: yes
  • FixSwitch - string - required: no - whether automatic fixing is supported: 0: no; 1: yes

    		•
    Limit No Integer Limit Entries, 10 by default, up to 100
    Offset No Integer Offset, which is 0 by default.
    Order No String Sorting Method: [ASC: Ascending Order, DESC: Descending Order]
    By No String Optional sorting columns: [PublishDate].

    3. Output Parameters

    Parameter Name Type Description
    List Array of VulStoreListInfo Vulnerability information
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number
    Remaining Integer Remaining Searches for Today
    FreeSearchTimes Integer Free Search Count
    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 Vulnerability Databases

    This example shows you how to obtain the list of vulnerability databases.

    Input Example

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

{
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ],
            "ExactMatch": true
        }
    ],
    "Limit": 0,
    "Offset": 0,
    "Order": "abc",
    "By": "abc"
}

    Output Example

    {
    "Response": {
        "List": [
            {
                "VulId": 1,
                "Level": 1,
                "Name": "abc",
                "CveId": "abc",
                "VulCategory": 1,
                "PublishDate": "abc",
                "Method": 1,
                "AttackLevel": 1,
                "FixSwitch": 1,
                "SupportDefense": 1
            }
        ],
        "TotalCount": 1,
        "Remaining": 1,
        "FreeSearchTimes": 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

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy