1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to get the overview statistics of CWP under the current account.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-05-20 15:12:33.
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: DescribeOverviewStatistics |
| 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 |
|---|---|---|
| BaseLineNum | Uint64 | Number of security baselines. Example: 1 |
| BruteAttackSuccessNum | Uint64 | Number of successful brute force attacks. Example: 1 |
| MalwareNum | Uint64 | Number of trojan files. Example: 1 |
| NonlocalLoginNum | Uint64 | Number of logins from unusual locations. Example: 1 |
| OnlineMachineNum | Uint64 | Number of online servers. Example: 1 |
| ProVersionMachineNum | Uint64 | Number of servers with CWP Pro. Example: 1 |
| VulNum | Uint64 | Number of vulnerabilities. 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.InvalidFormat | Incorrect parameter format. |
| MissingParameter | Missing parameter. |
| InternalError.MainDBFail | Failed to operate data. |