1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
Quick scan API
Default interface request rate limit: 20 times per second.
Interface update time: 2022-05-20 15:11:35.
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: ScanVul |
| 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. |
| HostType | Yes | No | Uint64 | 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: ["69796250-2a3a-40ef-b418-676e677019a4"] |
| ScanMethod | No | No | Uint64 | 0: version comparison, 2: version comparison + POC. Example: 0 |
| TimeoutPeriod | No | No | Uint64 | Timeout period. Unit: seconds. Default value: 3600. Example: 180 |
| VulCategories | No | No | String | Vulnerability category. 1: Web-CMS vulnerability. 2: application vulnerability. 4: Linux software vulnerability. 5: Windows system vulnerability. (Separate multiple values with semicolons (;).) Example: 1 |
| VulEmergency | No | No | Uint64 | Whether it is an emergency vulnerability. 0: no. 1: yes. Example: 1 |
| VulIds | No | No | Array of Uint64 | ID of the vulnerability that you want to scan. Example: [1] |
| VulLevels | Yes | No | String | Risk severity. 1: low. 2: medium. 3: high. 4: critical. (Separate multiple values with semicolons (;).) 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. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter.IllegalRequest | Invalid request. |
| 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. |