1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to obtain the micro-alarm overall summary.
Default interface request rate limit: 20 times per second.
Interface update time: 0001-01-01 00:00:00.
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: DescribeMaSummary |
| 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 |
|---|---|---|
| CustomPolicyCount | Uint64 | Number of custom allowlist policies deprecated. Example: 1 |
| EnableCustomPolicyCount | Uint64 | Total number of custom allowlist policies enabled. Example: 0 |
| EnableHostWorkloadCount | Uint64 | Number of server workloads with monitoring enabled. Example: 1 |
| EnablePodWorkloadCount | Uint64 | Number of pod workloads with monitoring enabled. Example: 1 |
| EnableWorkloadCount | Uint64 | Number of workloads with monitoring enabled. Example: 1 |
| GlobalWhitelistEnable | Uint64 | Whether the global allowlist is enabled. Example: 1 |
| HostWorkloadCount | Uint64 | Number of server workloads. Example: 1 |
| MonitorEnable | Uint64 | Whether the monitoring switch is enabled. Example: 1 |
| PodWorkloadCount | Uint64 | Number of pod workloads. Example: 1 |
| SelfLearnEnable | Uint64 | Whether self-learning is enabled. Example: 1 |
| TodayNewAlarmEventCount | Uint64 | Number of new alarm events today. Example: 0 |
| TotalCustomPolicyCount | Uint64 | Total number of custom allowlist policies enabled and disabled. Example: 1 |
| WhitelistCount | Uint64 | Number of global allowlists. 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. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter | Invalid parameter. |
| OperationDenied | Operation denied. |
| InvalidParameterValue | The parameter value is invalid. |