1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
MiniDashboard: pulls alarm-related information of an instance.
Default interface request rate limit: 20 times per second.
Interface update time: 2023-05-23 19:20:49.
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: DescribeMiniDashboardAlarmInfo |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-07-24 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| StartTime | Yes | No | Int64 | The start time. Example: 1611218128 |
| EndTime | Yes | No | Int64 | End time. Example: 1611218200 |
| MonitorType | Yes | No | String | Monitor type. Valid values: MT_QCE (Cloud Platform service monitoring) Example: MT_QCE |
| Namespace | Yes | No | String | Alarm namespace: Is used to distinguish between cloud products Example: cvm_device |
| Dimensions | Yes | No | String | Instance Information of Cloud Product, JSON Format Example: {"name":"instanceId","value":"1"} |
| Module | Yes | No | String | The value is fixed to "monitor". Example: monitor |
| SevenDaysStartTime | No | No | Int64 | Start Time of Total Quantity of Alarms Seven Days Ago Example: 1611218200 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AlarmCountInSevenDays | Int64 | Quantity of Alarms within Seven Days Example: 3 |
| AlarmHistory | Array of AlarmHistory | Alarm History in Specified Period Example:View |
| AlarmMetrics | Array of AlarmHistoryMetric | Alarm Metric Corresponding to Alarm History Example:View |
| PoliciesInfo | Array of MiniDashboardAlarmInfo | Whether Instance Has Policy Related Information 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 |
|---|---|
| ResourceNotFound | The resource does not exist. |
| UnsupportedOperation | Unsupported operation. |
| FailedOperation | Operation failed. |