tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeVulScanInfo

Last updated: 2024-07-22 11:04:09

    1. API Description

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

    This API is used to query the information of a vulnerability scan task.

    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: DescribeVulScanInfo.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    LocalTaskID No Integer ID of the task to scan local images for vulnerabilities. If it is not specified, the ID of the last scan will be returned.
    RegistryTaskID No Integer ID of the task to scan repository images for vulnerabilities. If it is not specified, the ID of the last scan will be returned.

    3. Output Parameters

    Parameter Name Type Description
    LocalImageScanCount Integer Total number of local images scanned this time
    IgnoreVulCount Integer Number of ignored vulnerabilities
    ScanStartTime String Start time of the vulnerability scan
    ScanEndTime String End time of the vulnerability scan
    FoundRiskImageCount Integer Number of images found to be at risk
    FoundVulCount Integer Number of vulnerabilities found in local images
    ScanProgress Float Scanning progress
    RegistryImageScanCount Integer Total number of repository images scanned this time
    LocalTaskID Integer ID of the last task to scan local images for vulnerabilities
    Status String Scanning status. Valid values: NOT_SCAN (not scanned); SCANNING (scanning); SCANNED (scanned); CANCELED (stopped).
    RemainingTime Float Remaining time in seconds
    RegistryTaskID Integer ID of the last task to scan repository images for vulnerabilities
    RegistryFoundVulCount Integer Number of vulnerabilities found in the repository
    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 information of a vulnerability scan task

    Input Example

    https://tcss.tencentcloudapi.com/?Action=DescribeVulScanInfo
&LocalTaskID=1
&RegistryTaskID=1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Status": "xx",
        "IgnoreVulCount": 0,
        "LocalImageScanCount": 1,
        "ScanEndTime": "xx",
        "ScanProgress": 0.0,
        "ScanStartTime": "xx",
        "RegistryImageScanCount": 1,
        "RegistryTaskID": 0,
        "RemainingTime": 0.0,
        "RegistryFoundVulCount": 0,
        "RequestId": "xx",
        "LocalTaskID": 0,
        "FoundRiskImageCount": 0,
        "FoundVulCount": 0
    }
}

    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.MissingParameter The required parameter is missing.
    InvalidParameter.ParsingError A parameter parsing error occurred.
    MissingParameter The parameter is missing.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy