ScanVulSetting

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

1. Interface Description

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

API for setting regular vulnerability scanning

Default interface request rate limit: 20 times per second.

Interface update time: 2023-03-06 19:25:31.

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: ScanVulSetting
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.
EnableScan	No	No	Uint64	Specifies whether to enable scanning. 1: yes. 0: no. Example: 1
EndTime	No	No	String	Time to stop scanning, such as 08:00. Example: 01:59
ScanMethod	No	No	Uint64	0: version comparison, 2: version comparison + POC. Example: 0
StartTime	No	No	String	Time to start scanning, such as 00:00. Example: 00:00
TimerInterval	Yes	No	Uint64	Interval for regular scans. Unit: days. Example: 1
TimerTime	No	No	String	Regular scan time, such as 02:10:50. Example: 02:10:50
Uuids	No	No	Array of String	If empty, scan hosts with all Professional, Premium, and General Discount editions by default; if not empty, only scan the selected hosts. Example: ["5a540076-d38a-4078-aa98-q45rt371d322"]
VulCategories	No	No	Array of Uint64	Vulnerability category. 1: Web-CMS vulnerability. 2: application vulnerability. 4: Linux software vulnerability. 5: Windows system vulnerability. Pass in the parameter value in the format of an array, such as [1,2]. Example: [1]
VulEmergency	No	No	Uint64	Whether it is an emergency vulnerability. 0: no. 1: yes. Example: 1
VulLevels	No	No	Array of Uint64	Risk severity. 1: low. 2: medium. 3: high. 4: critical. Pass in the parameter value in the format of an array, such as [1,2,3]. Example: [1]

3. Output Parameters

Parameter name	Type	Description
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.
InvalidParameter	Invalid parameter.
InvalidParameterValue	The parameter value is invalid.