Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to create an image scan task.
A maximum of 20 requests can be initiated per second for this API.
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: CreateAssetImageScanTask. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
| Images.N | No | Array of String | List of images to scan; choose one from all images, image list, and filter by condition. |
| ScanVul | No | Boolean | Scan vulnerabilities; select one from vulnerability, Trojan, and risk. |
| ScanVirus | No | Boolean | Scan for trojans; select either vulnerability, Trojan or risk. |
| ScanRisk | No | Boolean | Scan risk; select one from vulnerability, Trojan, and risk. |
| Filters.N | No | Array of AssetFilters | Filter images by conditions; select one from all images, image list, and filter by condition. |
| ExcludeImageIds.N | No | Array of String | Filter images by conditions and exclude individual images |
| ContainerRunning | No | Boolean | Whether the image has running containers |
| ScanScope | No | Integer | Scan range 0 all authorized images, 1 selected images, 2 recommended scan, 3 cluster scan Value ranges from 0 to 3 Default value: 0 |
| Timeout | No | Integer | Task timeout duration unit seconds, default 1 hour. |
| IsOneClickScanningTask | No | Boolean | One-click scan task. Default false indicates non-one-click scan, true one-click scan. |
| ClusterIDs.N | No | Array of String | Cluster ID. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskID | String | Task 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. |
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAssetImageScanTask
<Common request parameters>
{
"ScanVirus": true,
"ScanRisk": true,
"ScanVul": true,
"All": true,
"Images": []
}
{
"Response": {
"RequestId": "a6d8d540-940f-47d9-8d7f-daac832ba5b4",
"TaskID": "6013a6c334b9a9000cf519be"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.ErrAlreadyScanning | The scan is in progress or there is no scan permission. We recommend you perform the scan after authorization. |
| InternalError | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.InvalidFormat | The parameter format is incorrect. |
| InvalidParameter.ParsingError | A parameter parsing error occurred. |
| ResourceNotFound | The resource does not exist. |
피드백