Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to create an image scan task for an image repository.
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: CreateAssetImageRegistryScanTask. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
| All | No | Boolean | Whether to scan all images. |
| Images.N | No | Array of ImageInfo | List of images to be scanned. |
| ScanType.N | No | Array of String | Scan type array. |
| Id.N | No | Array of Integer | List of images to be scanned. |
| Filters.N | No | Array of AssetFilters | Filter conditions. |
| ExcludeImageList.N | No | Array of Integer | List of images that do not need to be scanned, used in conjunction with Filters. |
| OnlyScanLatest | No | Boolean | Whether to scan only the latest version of the image in each repository, used in conjunction with Filters. |
| Timeout | No | Integer | Task timeout duration. Unit: seconds. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskID | Integer | Returned 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: CreateAssetImageRegistryScanTask
<Common request parameters>
{
"Id": [
8741110
],
"ScanType": [
"CVE",
"VIRUS",
"RISK"
]
}
{
"Response": {
"RequestId": "68d5d49c-4b6b-46af-b060-46f521db0400"
}
}
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 | The operation failed. |
| InvalidParameter | The parameter is incorrect. |
| ResourceNotFound | The resource does not exist. |
文档反馈