Domain name for API request: csip.intl.tencentcloudapi.com.
Modify the scheduled scan configuration for malicious file scan, including scan cycle, detection mode, asset scope, engine selection, and quarantine configuration.
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: ModifyMalwareTimingScanSettings. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| Cycle | Yes | Integer | Scan cycle. Default: 1 per day |
| StartTime | Yes | String | Detection interval start time, such as 02:00:00 |
| EndTime | Yes | String | Detection interval timeout end time, such as 04:00:00 |
| MemberId.N | No | Array of String | Group account member id |
| EnableScan | No | Integer | Regular detection switch. 0: off; 1: on |
| ScanType | No | String | Detection mode: full/quick/include/exclude |
| CustomPaths.N | No | Array of String | Selected path list (required when ScanType is include/exclude, up to 100 entries) |
| AssetSelectionType | No | String | Asset selection method: all/tag/direct |
| TagIds.N | No | Array of String | Tag ID array for selecting by tag |
| InstanceIDsWithAppId.N | No | Array of InstanceIDWithAppIdItem | Host list for direct selection |
| ExcludeInstanceIDsWithAppId.N | No | Array of InstanceIDWithAppIdItem | Host exclusion list |
| ClusterIDsWithAppId.N | No | Array of ClusterIDWithAppIdItem | Cluster list by direct selection |
| ExcludeClusterIDsWithAppId.N | No | Array of ClusterIDWithAppIdItem | Cluster exclusion list |
| RealTimeMonitoring | No | Integer | Real-time monitoring. 0: off; 1: on |
| MonitoringPattern | No | Integer | Monitoring mode. 0: standard; 1: deep |
| MonitorCustomPaths.N | No | Array of String | Real-time monitoring custom path list (required when MonitoringPattern is 2 or 3, up to 100 entries) |
| EngineType | No | Integer | 1: standard mode (only critical and high-risk are reported.); 2: enhanced mode (critical, high-risk, and medium-risk are reported.); 3: strict mode (critical, high-risk, medium-risk, low-risk, and prompt are reported.) |
| EnableInspiredEngine | No | Integer | Heuristic engine switch. 0: off; 1: on |
| EnableMemShellScan | No | Integer | malicious process killing enabled [0: not enabled, 1: enabled] |
| AutoIsolation | No | Integer | Whether to automate isolation. 1: yes; 0: no |
| KillProcess | No | Integer | Whether to terminate the process. 1: terminate; 0: not terminate |
| DoClean | No | Integer | 1: clean; 0: do not clean. This operation repairs tampered system commands, scheduled tasks, and other system files. During the operation, please ensure yum/apt is available. |
| ProtectMode | No | Integer | Protection mode. 0: standard; 1: important period guarantee |
| ProtectFileScope | No | Integer | Scan scope: 0: malicious files other than scripts; 1: all malicious files |
| QuaraAssetSelectionType | No | String | Isolated asset selection: all/tag/direct |
| QuaraTagIds.N | No | Array of String | Tag ID array for selecting by tag in isolation |
| QuaraInstanceIDsWithAppId.N | No | Array of InstanceIDWithAppIdItem | Isolate the host for direct selection |
| QuaraExcludeInstanceIDsWithAppId.N | No | Array of InstanceIDWithAppIdItem | Isolate excluded hosts |
| QuaraClusterIDsWithAppId.N | No | Array of ClusterIDWithAppIdItem | Isolate clusters selected directly |
| QuaraExcludeClusterIDsWithAppId.N | No | Array of ClusterIDWithAppIdItem | Isolated excluded clusters |
| Timeout | No | Integer | Timeout duration (seconds) |
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMalwareTimingScanSettings
<Common request parameters>
{
"Cycle": 1,
"StartTime": "02:00:00",
"EndTime": "04:00:00",
"MemberId": [
"mem-tencent-e74488e0ba0cd8fe"
],
"EnableScan": 1,
"ScanType": "include",
"CustomPaths": [
"/detect/path"
],
"AssetSelectionType": "tag",
"TagIds": [
"1"
],
"RealTimeMonitoring": 1,
"MonitoringPattern": 2,
"MonitorCustomPaths": [
"/detect/path"
],
"EngineType": 3,
"EnableInspiredEngine": 0,
"EnableMemShellScan": 0,
"AutoIsolation": 1,
"KillProcess": 1,
"DoClean": 0,
"ProtectMode": 0,
"ProtectFileScope": 0,
"QuaraAssetSelectionType": "tag",
"QuaraTagIds": [
"1"
],
"Timeout": 7200
}{
"Response": {
"RequestId": "e49147da-7200-439c-a3d2-b76972ca7df4"
}
}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 | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| ResourceNotFound | The resource does not exist. |
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