tencent cloud

APIs

DokumentasiAPIsTencent Container Security ServiceImage Security APIsDescribeAssetImageScanSetting

DescribeAssetImageScanSetting

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-06-10 17:06:33

1. API Description

Domain name for API request: tcss.intl.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 No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
Enable Boolean

Switch.
ScanTime String

Scan time (complete time; backend parses hour/minute/second in UTC)
ScanPeriod Integer

Scan interval
ScanVirus Boolean

Scan for trojans
ScanRisk Boolean

Scan sensitive information
ScanVul Boolean

Scan vulnerabilities
Images Array of String

Custom scan image
ContainerRunning Boolean

Whether the image has running containers
ScanScope Integer

Scan range 0 all authorized images, 1 selected images, 2 recommended scan, 3 cluster filtering scan
ScanEndTime String

Scan end time 02:00 Time Division
ExcludeImages Array of String

Excluded scanned images
LastScanTime String

Last scan time
ScanResult String

Scanning result (Success
ClusterIDs Array of String

Cluster ID.
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 Getting image scan settings

Input Example

POST / HTTP/1.1
Host: tcss.intl.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.
Topik sebelumnya: DescribeAssetImageRiskListExportTopik selanjutnya: DescribeAssetImageScanStatus

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan