tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeImageRegistryTimingScanTask

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

    1. API Description

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

    This API is used to view a scheduled task of 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: DescribeImageRegistryTimingScanTask.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.

    3. Output Parameters

    Parameter Name Type Description
    Enable Boolean Scheduled scan switch
    Note: This field may return null, indicating that no valid values can be obtained.
    ScanTime String Scheduled scan time
    ScanPeriod Integer Scheduled scan interval
    ScanType Array of String Array of scan types
    Note: This field may return null, indicating that no valid values can be obtained.
    Images Array of ImageInfo Scan of specified images
    Note: This field may return null, indicating that no valid values can be obtained.
    Id Array of Integer ID of the specified image
    Note: This field may return null, indicating that no valid values can be obtained.
    Latest Boolean Whether to scan the latest image tag
    Note: This field may return·null, indicating that no valid values can be obtained.
    ScanEndTime String
    RegistryType Array of String
    ContainerRunning Boolean
    ScanScope Integer
    Namespace Array of String
    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 a scheduled task of an image repository

    This example shows you how to query a scheduled task of an image repository.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "RequestId": "f60f0ef9-a105-4535-8dfd-42ad8b3a9c73",
        "ScanTime": "03:00:00",
        "ScanPeriod": 1,
        "ScanType": [
            "risk",
            "virus"
        ],
        "All": false,
        "Images": [
            {
                "ImageDigest": "sha256:1319b1eaa0b7bcebae63af321fa67559b9517e8494060403d083bb3508fe52c8",
                "RegistryType": "ccr",
                "ImageRepoAddress": "ccr.ccs.tencentyun.com/yunding/luping:v1",
                "InstanceId": "",
                "InstanceName": "",
                "Namespace": "",
                "ImageName": "yunding/luping",
                "ImageTag": "v1",
                "Force": ""
            }
        ],
        "Id": [
            1
        ],
        "Enable": true,
        "Latest": true
    }
}

    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