Tenant Cloud
Security
Cloud Workload Protection Platform
Vulnerability Management APIs
DescribeVulHostTop
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
API for querying top server risks
Default interface request rate limit: 20 times per second.
Interface update time: 2022-09-06 14:58:32.
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: DescribeVulHostTop |
| 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. |
| IsFollowVul | No | No | Uint64 | Specifies whether to count only critical vulnerabilities. 1: only counts critical vulnerabilities. 0: counts all types of vulnerabilities Example: 1 |
| Top | Yes | No | Uint64 | Top N value, in the range of 1 to 100. Example: 1 |
| VulCategory | No | No | Uint64 | 1: Web-CMS vulnerability. 2: application vulnerability. 4: Linux software vulnerability. 5: Windows system vulnerability. 6: emergency vulnerability. If this parameter is left empty or set to 0, the supported types of vulnerabilities specified by 1, 2, 4, and 5 will be queried. Example: 2 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| VulHostTopList | Array of VulHostTopInfo | Top server risks. Example:View |
| 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. |