tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeMalwareTimingScanSetting

Last updated: 2024-12-06 15:39:25

1. API Description

Domain name for API request: cwp.intl.tencentcloudapi.com.

This API is used to query the scheduled scan configuration.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: 2018-02-28.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
CheckPattern Integer Detection mode: 0 - full disk detection; 1 - rapid detection
StartTime String Detection cycle; start time
EndTime String Detection cycle; timeout end time
IsGlobal Integer Whether all servers: 1 - all; 2 - specified
QuuidList Array of String When you select servers, host quuid is required.
Note: This field may return null, indicating that no valid values can be obtained.
MonitoringPattern Integer Monitoring mode: 0 - standard; 1 - deep
Cycle Integer Cycle: 1 - daily
EnableScan Integer Scheduled detection switch: 0 - disable; 1 - enable
Id Integer Unique ID
RealTimeMonitoring Integer Real-time monitoring: 0 - disable 1 - enable
AutoIsolation Integer Whether to isolate automatically: 1 - yes; 0 - no
ClickTimeout Integer One-click scan timeout duration, such as 1800 seconds
KillProcess Integer Whether to terminate the process: 1: terminate; 0: not terminate. It is effective only if automatic isolation is enabled.
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 Whether to enable malicious process killing [0: Not Enabled; 1: Enabled]
ProtectMode Integer Protection mode: 0 - standard; 1 - enhanced
ProtectFileScope Integer Scope of detection: 0 - malicious files other than scripts; 1 - all malicious files
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.

4. Example

Example1 Querying Scheduled Scan Configurations

Input Example

POST / HTTP/1.1
Host: cwp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMalwareTimingScanSetting
<Common request parameters>

{}

Output Example

{
    "Response": {
        "RequestId": "1e96ed81-a2f2-4029-893b-b63ed1328694",
        "CheckPattern": 1,
        "StartTime": "2020-05-20 00:00:00",
        "EndTime": "2020-05-20 00:00:00",
        "IsGlobal": 1,
        "QuuidList": [
            "972290ce-2e07-4689-8f92-f617239bbf82"
        ],
        "RealTimeMonitoring": 1,
        "MonitoringPattern": 0,
        "Cycle": 1,
        "EnableScan": 1,
        "Id": 0,
        "AutoIsolation": 1,
        "KillProcess": 1,
        "ClickTimeout": 0,
        "EngineType": 1,
        "EnableInspiredEngine": 1,
        "EnableMemShellScan": 1,
        "ProtectMode": 0,
        "ProtectFileScope": 0
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 Internal error
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy