tencent cloud

文档反馈

DescribeEmergencyVulList

最后更新时间:2024-08-27 11:37:16

1. API Description

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

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

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: DescribeEmergencyVulList.
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 Quantity of returns. The maximum value is 100.
Offset No Integer Offset, which defaults to 0
Filters.N No Array of Filters Filter criteria
  • Status - String - required: Yes - vulnerability status filter: 0: not detected; 1: at risk; 2: no risk; 3: show progress while detecting
  • Level - String - required: no - filter by vulnerability level: 1 - low; 2 - medium; 3 - high; 4 - prompt
  • VulName - String - required: no - vulnerability name search
  • Uuids- String - required: no - host uuid
  • IsSupportDefense - int- required: no - whether to support defense: 0: no; 1: yes
  • Order No String Sorting method: desc and asc
    By No String Sorting field PublishDate LastScanTime HostCount
    HotspotAttack No Boolean Whether hot spot vulnerabilities

    3. Output Parameters

    Parameter Name Type Description
    List Array of EmergencyVul 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.
    ExistsRisk Boolean Whether there is any risk
    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 Emergency Vulnerability List

    This example shows you the emergency vulnerability list.

    Input Example

    POST / HTTP/1.1
    Host: cwp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeEmergencyVulList
    <Common request parameters>
    
    {
        "Limit": "10",
        "Offset": "0"
    }
    

    Output Example

    {
        "Response": {
            "List": [
                {
                    "VulId": 1,
                    "Level": 1,
                    "VulName": "abc",
                    "PublishDate": "abc",
                    "Category": 1,
                    "Status": 1,
                    "LastScanTime": "abc",
                    "Progress": 1,
                    "CveId": "abc",
                    "CvssScore": 0,
                    "Labels": "abc",
                    "HostCount": 1,
                    "IsSupportDefense": 1,
                    "DefenseAttackCount": 1
                }
            ],
            "TotalCount": 1,
            "ExistsRisk": true,
            "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.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.