Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to set an image scan.
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: CreateAssetImageScanSetting. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
| Enable | Yes | Boolean | Switch. |
| ScanTime | Yes | String | Scan start time |
| ScanPeriod | Yes | Integer | Scan cycle |
| ScanVirus | Yes | Boolean | Scan for trojans |
| ScanRisk | Yes | Boolean | Scan sensitive information |
| ScanVul | Yes | Boolean | Scan for vulnerabilities |
| Images.N | No | Array of String | Custom Image |
| ContainerRunning | No | Boolean | Whether the image has running containers |
| ScanScope | No | Integer | Scan range 0 all authorized images, 1 select mirror, 2 recommended scan, 3 cluster filtering scan Value ranges from 0 to 3 Default value: 0 |
| ScanEndTime | No | String | Scan end time |
| ExcludeImages.N | No | Array of String | Exclude mirror scan |
| ClusterIDs.N | No | Array of String | Cluster ID. |
| 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 set an image scan.
POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAssetImageScanSetting
<Common request parameters>
{
"Enable": true,
"ScanTime": "2020-12-28 15:53:26",
"ScanPeriod": 3600,
"ScanVirus": true,
"ScanRisk": true,
"ScanVul": true,
"All": true,
"Images": []
}
{
"Response": {
"RequestId": "af170769-a009-4c51-879a-8fe182ace76e"
}
}
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 |
|---|---|
| InternalError | An internal error occurred. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.InvalidFormat | The parameter format is incorrect. |
| InvalidParameter.ParsingError | A parameter parsing error occurred. |
| MissingParameter | The parameter is missing. |
フィードバック