tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateAssetImageRegistryScanTask

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

    1. API Description

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

    This API is used to create an image scan task for an image repository.

    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: CreateAssetImageRegistryScanTask.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    All No Boolean Whether to scan all images
    Images.N No Array of ImageInfo List of scanned images
    ScanType.N No Array of String Array of scan types
    Id.N No Array of Integer List of scanned images
    Filters.N No Array of AssetFilters Filter
    ExcludeImageList.N No Array of Integer List of images not to be scanned, which is used together with Filters.
    OnlyScanLatest No Boolean Whether to scan only the latest repository images, which is used together with Filters.

    3. Output Parameters

    Parameter Name Type Description
    TaskID Integer
    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 正常请求

    正常请求

    Input Example

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

{
    "All": false,
    "Id": [
        1256299843
    ],
    "OnlyScanLatest": false
}

    Output Example

    {
    "Response": {
        "RequestId": "538366ac-d056-4f69-92ca-cf9bc6c9463b",
        "TaskID": 2
    }
}

    Example2 Creating an image scan task for an image repository

    Input Example

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

{
    "Id": [
        8741110
    ],
    "ScanType": [
        "CVE",
        "VIRUS",
        "RISK"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "68d5d49c-4b6b-46af-b060-46f521db0400"
    }
}

    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
    FailedOperation The operation failed.
    InvalidParameter The parameter is incorrect.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy