tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAssetImageScanSetting

Last updated: 2023-12-04 17:12:53

    1. API Description

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

    This API is used to get the image scan settings.

    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: DescribeAssetImageScanSetting.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou.

    3. Output Parameters

    Parameter Name Type Description
    Enable Boolean Switch
    ScanTime String Scan time, which is a complete time and parsed as hour/minute/second in time zone 0 on the backend.
    ScanPeriod Integer Scan interval
    ScanVirus Boolean Trojan scan
    ScanRisk Boolean Sensitive data scan
    ScanVul Boolean Vulnerability scan
    All Boolean Scan of all images
    Images Array of String Scan of specified images
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting image scan settings

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "All": false,
        "Enable": true,
        "Images": [
            "sha256:f8d1d3fe96d0bb9d04eab9043b53ed5280a409db58f2506e9f65caa11bb39ad1"
        ],
        "RequestId": "6732aa52-9940-49c3-a8be-361c312b1ee5",
        "ScanPeriod": 1,
        "ScanRisk": false,
        "ScanTime": "11:05:00",
        "ScanVirus": true,
        "ScanVul": false
    }
}

    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
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.MissingParameter The required parameter is missing.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy