DescribeScanVulSetting

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

1. Interface Description

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

This API is used to query the regular check settings.

Default interface request rate limit: 20 times per second.

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

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: DescribeScanVulSetting
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.

3. Output Parameters

Parameter name	Type	Description
ClickTimeout	Uint64	Timeout period for the quick scan, such as 1800 seconds. Example: 600
EnableScan	Uint64	Indicates whether self-healing notifications are enabled. Example: 1
EndTime	String	End time. Example: 05:00
ScanMethod	Uint64	0: version comparison, 2: version comparison + POC. Example: 0
StartTime	String	Start time. Example: 00:00
TimerInterval	Uint64	Interval for regular scans. Unit: days. Example: 1
TimerTime	String	Regular check time, such as 00:00. Example: 00:00
Uuids	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: ["d99a1b46-cc2d-4633-a11f-4a7663d25ay*"]
VulCategories	String	Vulnerability category. 1: Web-CMS vulnerability. 2: application vulnerability. 4: Linux software vulnerability. 5: Windows system vulnerability. Example: 1
VulEmergency	Uint64	Indicates whether it is an emergency vulnerability. 0: no. 1: yes. Example: 1
VulLevels	String	Risk severity. 1: low. 2: medium. 3: high. 4: critical. Multiple risk severity levels are separated with commas (,). 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
InvalidParameter.ParsingError	Parameter parsing error.
InvalidParameter.MissingParameter	Missing parameter.
MissingParameter	Missing parameter.
InternalError.MainDBFail	Failed to operate data.
InvalidParameter	Invalid parameter.
InvalidParameterValue	The parameter value is invalid.