Domain name for API request: tcss.intl.tencentcloudapi.com.
Update scheduled tasks in the mirror 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: UpdateImageRegistryTimingScanTask. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ScanPeriod | Yes | Integer | Scheduled scan cycle |
| Enable | Yes | Boolean | Scheduled scan switch |
| ScanTime | Yes | String | The time for scheduled scan |
| ScanType.N | No | Array of String | Array of Trojan horse types to scan |
| Images.N | No | Array of ImageInfo | Scan image |
| Id.N | No | Array of Integer | Scan Image ID |
| Latest | No | Boolean | Whether to Scan the Latest Version |
| ContainerRunning | No | Boolean | Whether There Are Running Containers |
| ScanEndTime | No | String | Scan end time |
| ScanScope | No | Integer | Scan Scope. 0: All Images; 1: Custom Images; 2: Recommended Scan Images |
| RegistryType.N | No | Array of String | Repository Type: tcr, ccr, harbor |
| Namespace.N | No | Array of String | Namespace |
| ExcludeImageAssetIds.N | No | Array of Integer | IDs of excluded image assets. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
This example shows you how to scan all authorized latest images for vulnerabilities.
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateImageRegistryTimingScanTask
<Common request parameters>
{
"Enable": true,
"ScanPeriod": 1,
"ScanTime": "18:10",
"ScanEndTime": "20:00",
"ScanScope": 2,
"ContainerRunning": false,
"Id": [],
"Namespace": [
"tke-images"
],
"RegistryType": [
"ccr"
],
"Latest": true,
"ScanType": [
"CVE",
"VIRUS",
"RISK"
],
"ExcludeImageAssetIds": []
}{
"Response": {
"RequestId": "5f2acb2d-2775-4ef4-8230-03df2762b1d1"
}
}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 |
|---|---|
| InvalidParameter | Parameter error. |
| ResourceNotFound |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback