Tenant Cloud
Security
Cloud Workload Protection Platform
Intrusion Detection - File Scanning and Cleaning APIs
DescribeMalwareTimingScanSetting
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
API for querying the scheduled scan configuration
Default interface request rate limit: 20 times per second.
Interface update time: 2022-10-25 19:31:47.
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: DescribeMalwareTimingScanSetting |
| 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. |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AutoIsolation | Uint64 | Indicates whether auto-quarantine is enabled. 1: enabled. 0: not enabled. Example: 1 |
| CheckPattern | Uint64 | Scan mode. 0: full-disk scan. 1: quick scan. Example: 1 |
| ClickTimeout | Uint64 | Timeout period for the quick scan, such as 1800 seconds. Example: 60 |
| Cycle | Uint64 | Scan cycle. 1: every day. Example: 1 |
| EnableInspiredEngine | Uint64 | Heuristic Engine: 0 - OFF, 1 - ON Example: 1 |
| EnableMemShellScan | Uint64 | Whether to enable malicious process killing [0: Not Enabled; 1: Enabled] Example: 1 |
| EnableScan | Int64 | Indicates whether scheduled scanning is enabled. 0: disabled. 1: enabled. Example: 1 |
| EndTime | String | End time of the scan. Example: 18:00 |
| EngineType | 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 |
| Id | Int64 | Unique ID. Example: 1 |
| IsGlobal | Uint64 | Specifies whether to specify all servers. 1: all servers. 2: selected servers. Example: 1 |
| KillProcess | Uint64 | Indicates whether to kill the process. 1: kills the process. 0: does not kill the process. This parameter takes effect only when the AutoIsolation parameter is set to 1. Example: 1 |
| MonitoringPattern | Uint64 | Monitoring mode. 0: standard mode. 1: deep mode. Example: 1 |
| ProtectFileScope | Uint64 | Scope of detection: 0: malicious files other than scripts; 1: all malicious files Example: 0 |
| ProtectMode | Uint64 | Protection mode: 0 - standard; 1 - enhanced Example: 0 |
| QuuidList | Array of String | QUUIDs of servers. This parameter is required if you set IsGlobal to 2. Example: ["972290ce-2e07-4689-8f92-f617239bbf82"] |
| RealTimeMonitoring | Int64 | Indicates whether real-time monitoring is enabled. 0: disabled. 1: enabled. Example: 1 |
| StartTime | String | Start time of the scan. Example: 00:00 |
| 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. |