Domain name for API request: tcss.intl.tencentcloudapi.com.
Creating a Task to Scan Images in an Image Repository with One Click
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: CreateAssetImageRegistryScanTaskOneKey. |
| 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 ImageInfo | Scanned Image List |
| ScanType.N | No | Array of String | Type Array for scanning |
| Id.N | No | Array of Integer | Scanned Image List ID |
| ExcludeIDs.N | No | Array of Integer | List of image IDs excluded from scanning. |
| IsLatest | No | Boolean | Whether the Latest Image |
| ScanScope | No | Integer | Scan Scope. 0: All Images; 1: Custom Images; 2: Recommended Scan Images |
| RegistryType.N | No | Array of String | Repository type |
| Namespace.N | No | Array of String | Namespace |
| ContainerRunning | No | Boolean | Whether There Are Running Containers |
| Timeout | No | Integer | Task Timeout Duration Unit (s) |
| Parameter Name | Type | Description |
|---|---|---|
| TaskID | Integer | Scan 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. |
Creating a Task to Scan Images in an Image Repository with One Click
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAssetImageRegistryScanTaskOneKey
<Common request parameters>
{
"All": true,
"ScanType": [
"CVE",
"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 | Parameter error. |
| ResourceNotFound |
피드백