CreateScanMalwareSetting

Last Updated At: 2026-08-02 00:05:00

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

This API is used to configure the file scanning and cleaning settings in the intrusion detection module.

Default interface request rate limit: 20 times per second.

Interface update time: 2022-11-03 19:52:53.

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: CreateScanMalwareSetting
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.
EnableMemShellScan No No Int64 Whether to enable malicious process killing [0: Not Enabled; 1: Enabled].
Example: 1
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: 2
HostType Yes No Int64 Server type. 1: server with CWP Pro. 2: selected server.
Example: 1
QuuidList No No Array of String QUUIDs of servers. This parameter takes effect if the HostType parameter is set to 2 (selected server).
Example: ["a15a2cac-0bea-478d-a5d0-f54be8ayayay""]
ScanPattern Yes No Uint64 Scan mode. 0: full-disk scan. 1: quick scan.
Example: 1
TimeoutPeriod No No Uint64 Timeout period. Unit: seconds. Default value: 3600.
Example: 1

3. Output Parameters

Parameter name Type Description
TaskId Uint64 Task ID.
Example: 1
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.
FailedOperation.NoProfessionHost No servers with CWP Pro exist.
InvalidParameter Invalid parameter.
OperationDenied Operation denied.
InvalidParameterValue The parameter value is invalid.
FailedOperation Operation failed.