tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateScanMalwareSetting

Last updated: 2024-08-27 11:38:05

1. API Description

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

This API is used to detect the intrusion and virus scanning.

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: CreateScanMalwareSetting.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
ScanPattern Yes Integer Scan mode: 0 - full disk scan; 1 - rapid scan
HostType Yes Integer Server classification: 1: Professional Edition servers; 2: self-selected servers
QuuidList.N No Array of String Effective for selected servers; a string array of host QUUIDs
TimeoutPeriod No Integer Timeout unit: seconds, which is 3,600 seconds by default.
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.)
EnableMemShellScan No Integer Whether to enable malicious process killing [0: Not Enabled; 1: Enabled]

3. Output Parameters

Parameter Name Type Description
TaskId Integer Task ID
Note: This field may return null, indicating that no valid values can be obtained.
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 One-Click Detection

Input Example

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

{
    "ScanPattern": "0",
    "HostType": "1"
}

Output Example

{
    "Response": {
        "RequestId": "007863e7-fce9-49c2-9561-16bc2a522620",
        "TaskId": 1
    }
}

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
FailedOperation Operation failed.
FailedOperation.APIServerFail Failed to invoke the API service.
FailedOperation.NoProfessionHost No Pro Edition host.
InternalError Internal error
InvalidParameter Incorrect parameter.
InvalidParameter.DateRange Incorrect time range format.
InvalidParameter.IllegalRequest Invalid request.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
OperationDenied The operation was denied.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy