tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeVulScanLocalImageList

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

    1. API Description

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

    This API is used to query the list of local images in 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: DescribeVulScanLocalImageList.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    TaskID Yes Integer Vulnerability scan task ID
    Filters.N No Array of RunTimeFilters Filter
  • OnlyAffectedNewestImage- Bool- Required: No - Show only vulnerabilities that affect the latest image tags
  • ImageID- string - Required: No - Image ID
  • ImageName- String - Required: No - Image name
  • ScanStatus- string - Required: No - Check status. Valid values: WAIT_SCAN (pending); SCANNING (checking); SCANNED (checked); SCAN_ERR (failed to check); CANCELED (check ended).
    		•
    Limit No Integer Number of results to be returned. Default value: 10. Maximum value: 100.
    Offset No Integer Offset. Default value: 0.
    Order No String Sorting order
    By No String Sorting field

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of images
    List Array of VulScanImageInfo List of images
    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 list of local images in a vulnerability scan task

    Input Example

    https://tcss.tencentcloudapi.com/?Action=DescribeVulScanLocalImageList
&TaskID=1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "List": [
            {
                "MediumLevelVulCount": 0,
                "ScanStatus": "xx",
                "ScanEndTime": "xx",
                "ScanStartTime": "xx",
                "ErrorStatus": "xx",
                "ImageID": "xx",
                "ImageName": "xx",
                "CriticalLevelVulCount": 0,
                "TaskID": 0,
                "ScanDuration": 0.0,
                "HighLevelVulCount": 0,
                "LowLevelVulCount": 0,
                "Size": 0.0
            }
        ],
        "RequestId": "xx"
    }
}

    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.
    InvalidParameterValue The parameter value is incorrect.
    MissingParameter The parameter is missing.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy