1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
V2.0 Alarm history list API
Default interface request rate limit: 20 times per second.
Interface update time: 2025-07-22 18:10:52.
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: DescribeAlarmHistories |
| 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 |
| PageNumber | No | No | Int64 | Number of pages. It starts from 1 and the default value is 1. Example: 1 |
| PageSize | No | No | Int64 | Number of entries per page. Value range: 1-100. Default: 20. Example: 20 |
| Order | No | No | String | Sorts by the first occurrence time in descending order by default. Valid values: ASC (ascending), DESC (descending). Example: DESC |
| StartTime | No | No | Int64 | Start time. The default value is the timestamp that is 1 day ago from this day. Example: 1611600000 |
| EndTime | No | No | Int64 | End time. The default value is the current timestamp. Example: 1611650000 |
| MonitorTypes | No | No | Array of String | Filters by monitor type. Valid values: "MT_QCE" (Cloud Platform service monitoring), "MT_CUSTOM" (custom monitoring), "MT_PROME"=prometheus monitoring. If this parameter is left empty, all types will be queried by default. Example: MT_QCE |
| AlarmObject | No | No | String | Filter by alarm object. Fuzzy search with string is supported. Example: tdsqlshard-h2phzy69 |
| AlarmStatus | No | No | Array of String | Filters by alarm status. Valid values: ALARM (not resolved), OK (resolved), NO_CONF (expired), NO_DATA (insufficient data). If this parameter is left empty, all will be queried by default. Example: ALARM |
| ProjectIds | No | No | Array of Int64 | Filters by project ID. Valid values: -1 (no project), 0 (default project). Example: 10 |
| InstanceGroupIds | No | No | Array of Int64 | Filters by instance group ID Example: 10 |
| Namespaces | No | No | MonitorTypeNamespace | Filters by policy type. Example:View |
| PolicyName | No | No | String | Fuzzy search by policy name. Example: Testing |
| Content | No | No | String | Fuzzy search by alarm content. Example: abc |
| ReceiverUids | No | No | Array of Int64 | Searches by recipient Example: 1234 |
| ReceiverGroups | No | No | Array of Int64 | Searches by recipient group. Example: 1234 |
| Module | Yes | No | String | The value is fixed to "monitor". Example: monitor |
| PolicyIds | No | No | Array of String | Searches by alarm policy ID list. Example: policy-abcedf |
| MetricNames | No | No | Array of String | Filters by metric name. Example: CpuUsage |
| UniqueIds | No | No | Array of String | Searches by unique ID of the alarm instance. Example: dadeqe13czc |
| Dimensions | No | No | String | Dimension information of an instance. Example: [[{"name":"unInstanceId","value":"ins-abcdef"}]] |
| AlarmLevel | No | No | Array of String | Alarm Level Example: Remind |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Int64 | Total number. Example: 100 |
| Histories | Array of AlarmHistory | Alarm history list. 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 | Invalid parameter. |
| LimitExceeded | The quota limit has been reached. |
| InvalidParameterValue | Invalid parameter value. |
| MissingParameter | Missing parameter. |