告警2.0-告警历史列表
最近更新时间: 2024-09-03 18:49:57
1. 接口描述
接口请求域名： monitor.api3.cloud.sunhongs.com。
告警2.0-告警历史列表
默认接口请求频率限制：20次/秒。
接口更新时间：2023-01-17 15:40:22。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeAlarmHistories |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| PageNumber | 否 | 否 | Int64 | 页数，从 1 开始计数，默认 1 |
| PageSize | 否 | 否 | Int64 | 每页的数量，取值1~100，默认20 |
| Order | 否 | 否 | String | 默认按首次出现时间倒序排列 "ASC"=正序 "DESC"=逆序 |
| StartTime | 否 | 否 | Int64 | 起始时间，默认一天前的时间戳 |
| EndTime | 否 | 否 | Int64 | 结束时间，默认当前时间戳 |
| MonitorTypes | 否 | 否 | Array of String | 根据监控类型过滤 不选默认查所有类型 "MT_QCE"=云产品监控 "MT_CUSTOM"=自定义监控 "MT_PROME"=prometheus监控 |
| AlarmObject | 否 | 否 | String | 根据告警对象过滤 字符串模糊搜索 |
| AlarmStatus | 否 | 否 | Array of String | 根据告警状态过滤 ALARM=未恢复 OK=已恢复 NO_CONF=已失效 NO_DATA=数据不足，不选默认查所有 |
| ProjectIds | 否 | 否 | Array of Int64 | 根据项目ID过滤，-1=“-“项目 0=默认项目 |
| InstanceGroupIds | 否 | 否 | Array of Int64 | 根据实例组ID过滤 |
| Namespaces | 否 | 否 | MonitorTypeNamespace | 根据策略类型过滤 |
| PolicyName | 否 | 否 | String | 根据策略名称模糊搜索 |
| Content | 否 | 否 | String | 根据告警内容模糊搜索 |
| ReceiverUids | 否 | 否 | Array of Int64 | 根据接收人搜索 |
| ReceiverGroups | 否 | 否 | Array of Int64 | 根据接收组搜索 |
| Module | 是 | 否 | String | 固定值，为"monitor" |
| PolicyIds | 否 | 否 | Array of String | 根据告警策略 Id 列表搜索 |
| MetricNames | 否 | 否 | Array of String | 根据指标名过滤 |
| UniqueIds | 否 | 否 | Array of String | 根据告警实例 UniqueId 搜索 |
| Dimensions | 否 | 否 | String | 实例的维度信息 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 总数 |
| Histories | AlarmHistory | 此参数对外不可见。 告警历史列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | |
| InvalidParameter | |
| LimitExceeded | |
| InvalidParameterValue | |
| MissingParameter |