Domain name for API request: csip.intl.tencentcloudapi.com.
This API is used to query the scheduled scan configuration for file scan and removal.
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: DescribeMalwareTimingScanSetting. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| MemberId.N | No | Array of String | Group account member id |
| Parameter Name | Type | Description |
|---|---|---|
| EnableScan | Integer | Regular detection switch. 0: off; 1: on |
| Cycle | Integer | Period 1: daily |
| StartTime | String | Interval. Start time. |
| EndTime | String | Detection cycle. Timeout end time. |
| ScanType | String | Detection mode |
| CustomPaths | Array of String | Selected path list |
| AssetSelectionType | String | Asset selection method |
| TagIds | Array of String | Tag ID array |
| InstanceIDsWithAppId | Array of InstanceIDWithAppIdItem | Host list for direct selection |
| ExcludeInstanceIDsWithAppId | Array of InstanceIDWithAppIdItem | Host exclusion list |
| ClusterIDsWithAppId | Array of ClusterIDWithAppIdItem | Cluster list by direct selection |
| ExcludeClusterIDsWithAppId | Array of ClusterIDWithAppIdItem | Cluster exclusion list |
| RealTimeMonitoring | Integer | Real-time monitoring. 0: off; 1: on |
| MonitoringPattern | Integer | Monitoring mode. 0: standard; 1: deep |
| MonitorCustomPaths | Array of String | Real-time monitoring custom path list |
| EngineType | 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 | Integer | Heuristic engine. 0: off; 1: on |
| EnableMemShellScan | Integer | malicious process killing enabled [0: not enabled, 1: enabled] |
| AutoIsolation | Integer | Whether to isolate automatically: 1 - yes; 0 - no |
| KillProcess | Integer | Whether to terminate the process: 1: terminate; 0: not terminate. It takes effect only if automatic isolation is enabled. |
| DoClean | Integer | Execute cleanup switch. 0: off; 1: on |
| ProtectMode | Integer | Protection mode. 0: standard; 1: important period guarantee |
| ProtectFileScope | Integer | Scan scope: 0: malicious files other than scripts; 1: all malicious files |
| QuaraAssetSelectionType | String | Isolated asset selection |
| QuaraTagIds | Array of String | Isolation tag ID array |
| QuaraInstanceIDsWithAppId | Array of InstanceIDWithAppIdItem | Isolate hosts for direct selection |
| QuaraExcludeInstanceIDsWithAppId | Array of InstanceIDWithAppIdItem | Exclusion of isolated hosts |
| QuaraClusterIDsWithAppId | Array of ClusterIDWithAppIdItem | Isolate clusters by direct selection |
| QuaraExcludeClusterIDsWithAppId | Array of ClusterIDWithAppIdItem | Cluster excluded from isolation |
| Timeout | Integer | Timeout duration (seconds) |
| 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: DescribeMalwareTimingScanSetting
<Common request parameters>
{
"MemberId": [
"mem-tencent-e74488e0ba0cd8fe"
]
}{
"Response": {
"AssetSelectionType": "tag",
"AutoIsolation": 1,
"ClusterIDsWithAppId": [],
"CustomPaths": [
"/detect/path"
],
"Cycle": 1,
"DoClean": 0,
"EnableInspiredEngine": 0,
"EnableMemShellScan": 0,
"EnableScan": 1,
"EndTime": "17:40",
"EngineType": 3,
"ExcludeClusterIDsWithAppId": [],
"ExcludeInstanceIDsWithAppId": [],
"InstanceIDsWithAppId": [],
"KillProcess": 1,
"MonitorCustomPaths": [
"/detect/path"
],
"MonitoringPattern": 2,
"ProtectFileScope": 0,
"ProtectMode": 0,
"QuaraAssetSelectionType": "tag",
"QuaraClusterIDsWithAppId": [],
"QuaraExcludeClusterIDsWithAppId": [],
"QuaraExcludeInstanceIDsWithAppId": [],
"QuaraInstanceIDsWithAppId": [],
"QuaraTagIds": [
"1"
],
"RealTimeMonitoring": 1,
"ScanType": "include",
"StartTime": "00:00",
"TagIds": [
"1"
],
"Timeout": 7200,
"RequestId": "e6325de7-3b87-4a0d-b319-2b105839a60c"
}
}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