tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeVulSummary

Last updated: 2024-07-22 11:07:13

    1. API Description

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

    This API is used to query the overview of vulnerability risks.

    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: DescribeVulSummary.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    Filters.N No Array of RunTimeFilters Filter
  • OnlyAffectedNewestImage- string- Required: No - Show only vulnerabilities that affect the latest image tags. Valid values: true, false.
  • OnlyAffectedContainer-string- Required: No - Show only vulnerabilities that affect containers. Valid values: true, false.
  • CategoryType- string - Required: No - Vulnerability type. Valid values: SYSTEM (system vulnerability); WEB (web application vulnerability); ALL (all vulnerabilities).
    		•

    3. Output Parameters

    Parameter Name Type Description
    VulTotalCount Integer Total number of vulnerabilities
    SeriousVulCount Integer Number of critical and high-risk vulnerabilities
    SuggestVulCount Integer Number of high-priority vulnerabilities
    PocExpLevelVulCount Integer Number of vulnerabilities with POC or EXP
    RemoteExpLevelVulCount Integer Number of vulnerabilities with remote EXP
    SeriousVulNewestImageCount Integer Number of images on the latest version affected by critical or high-risk vulnerabilities
    SystemVulnerabilityFocusCount Integer Number of high-priority system vulnerabilities
    WebVulnerabilityFocusCount Integer Number of high-priority web vulnerabilities
    SeriousVulnerabilityLocalImageCount Integer Number of affected local images
    SeriousVulnerabilityRegistryImageCount Integer Number of affected repository images
    EmergencyVulnerabilityCount Integer Number of emergency vulnerabilities
    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 Querying the vulnerability statistics

    The following example shows how to query the vulnerability statistics.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "VulTotalCount": 0,
        "SeriousVulCount": 0,
        "SuggestVulCount": 0,
        "PocExpLevelVulCount": 0,
        "RemoteExpLevelVulCount": 0,
        "SeriousVulNewestImageCount": 0,
        "SystemVulnerabilityFocusCount": 0,
        "WebVulnerabilityFocusCount": 0,
        "SeriousVulnerabilityLocalImageCount": 0,
        "SeriousVulnerabilityRegistryImageCount": 0,
        "EmergencyVulnerabilityCount": 0,
        "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
    AuthFailure A CAM signature/authentication error occurred.
    InternalError An internal error occurred.
    InternalError.MainDBFail The database operation failed.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidFormat The parameter format is incorrect.
    InvalidParameter.ParsingError A parameter parsing error occurred.
    InvalidParameterValue The parameter value is incorrect.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy