Tenant Cloud
Security
Cloud Workload Protection Platform
Intrusion Detection - File Scanning and Cleaning APIs
ModifyMalwareTimingScanSettings
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
API for setting scheduled scans
Default interface request rate limit: 20 times per second.
Interface update time: 2022-11-03 19:52:01.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyMalwareTimingScanSettings |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-02-28 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| AutoIsolation | No | No | Uint64 | Specifies whether to enable the auto-quarantine feature. 1: enables the feature. 2: disables the feature. Example: 1 |
| CheckPattern | Yes | No | Uint64 | Scan mode. 0: full-disk scan. 1: quick scan. Example: 1 |
| Cycle | Yes | No | Uint64 | Scan cycle. By default, the system performs scans once every day. Example: 1 |
| DoClean | No | No | Uint64 | 1: Clean. 0: Do not clean. Example: 1 |
| EnableInspiredEngine | No | No | Uint64 | Heuristic Engine Switch: 0 OFF, 1 ON. Example: 1 |
| EnableMemShellScan | No | No | Uint64 | Whether to enable malicious process killing [0: Not Enabled; 1: Enabled]. Example: 1 |
| EnableScan | Yes | No | Uint64 | Specifies whether to enable the scheduled scan feature. 0: disables the feature. 1: enables the feature. Example: 1 |
| EndTime | Yes | No | String | End time of the scan, such as 04:00:00. Example: 02:00:00 |
| EngineType | No | No | Uint64 | 1: standard mode (only critical and high-risk issues are reported). 2: enhanced mode (critical, high-risk, and medium-risk issues are reported). 3: strict mode (critical, high-risk, medium-risk, low-risk, and informational issues are reported). Example: 1 |
| IsGlobal | Yes | No | Uint64 | Specifies whether to specify all servers. 1: all servers. 2: selected servers. Example: 1 |
| KillProcess | No | No | Uint64 | Specifies whether to kill the process. 1: kills the process. 0: does not kill the process. Example: 1 |
| MonitoringPattern | Yes | No | Uint64 | Monitoring mode. 0: standard mode. 1: deep mode. Example: 1 |
| ProtectFileScope | No | No | Uint64 | Scope of detection: 0: malicious files other than scripts; 1: all malicious files Example: 0 |
| ProtectMode | No | No | Uint64 | Protection mode: 0: standard; 1: important period guarantee Example: 0 |
| QuuidList | No | No | Array of String | QUUIDs of servers. This parameter is required if you set IsGlobal to 2. Example: ["5a540076-d38a-4078-aa98-q45rt371d322"] |
| RealTimeMonitoring | Yes | No | Uint64 | Specifies whether to enable real-time monitoring. 0: disables real-time monitoring. 1: enables real-time monitoring. Example: 1 |
| StartTime | Yes | No | String | Start time of the scan, such as 02:00:00. Example: 00:00:00 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter.ParsingError | Parameter parsing error. |
| InvalidParameter.MissingParameter | Missing parameter. |
| InvalidParameter.InvalidFormat | Incorrect parameter format. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter.IllegalRequest | Invalid request. |
| InvalidParameter.DateRange | The time range format is incorrect. |
| FailedOperation.APIServerFail | Failed to call the API service. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | The parameter value is invalid. |
| FailedOperation | Operation failed. |