tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateImageRegistryTimingScanTask

Last updated: 2024-07-22 11:06:51

    1. API Description

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

    This API is used to update a scheduled 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: UpdateImageRegistryTimingScanTask.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    ScanPeriod Yes Integer Scheduled scan cycle
    Enable Yes Boolean Scheduled scan switch
    ScanTime Yes String Scheduled scan time
    ScanType.N No Array of String Array of the scanned trojan types
    Images.N No Array of ImageInfo Scanned image
    Id.N No Array of Integer ID of the image to be scanned
    Latest No Boolean Whether to scan for the latest version
    ContainerRunning No Boolean
    ScanEndTime No String
    ScanScope No Integer
    RegistryType.N No Array of String
    Namespace.N No Array of String

    3. Output Parameters

    Parameter Name Type Description
    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 Scan authorized images with the latest tags

    This example shows you how to scan authorized images with the latest tags for vulnerabilities.

    Input Example

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

{
    "ScanPeriod": 1,
    "ScanType": [
        "CVE"
    ],
    "Images": [
        {
            "ImageDigest": "abc",
            "RegistryType": "abc",
            "ImageRepoAddress": "abc",
            "InstanceId": "abc",
            "InstanceName": "abc",
            "Namespace": "abc",
            "ImageName": "abc",
            "ImageTag": "abc",
            "Force": "abc"
        }
    ],
    "All": true,
    "Latest": true,
    "Enable": true,
    "ScanTime": "04:00:00",
    "Id": [
        1
    ]
}

    Output Example

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