获取基础告警列表
最近更新时间: 2024-10-18 10:38:29
1. 接口描述
接口请求域名： monitor.api3.fincloud.tencent.cn。
获取基础告警列表
默认接口请求频率限制：20次/秒。
接口更新时间：2020-09-25 15:17:37。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeBasicAlarmList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Module | 是 | 否 | String | 接口模块名，当前取值monitor |
| StartTime | 否 | 否 | Int64 | 起始时间，默认一天前的时间戳 |
| EndTime | 否 | 否 | Int64 | 结束时间，默认当前时间戳 |
| Limit | 否 | 否 | Int64 | 分页参数，每页返回的数量，取值1~100，默认20 |
| Offset | 否 | 否 | Int64 | 分页参数，页偏移量，从0开始计数，默认0 |
| OccurTimeOrder | 否 | 否 | String | 根据发生时间排序，取值ASC或DESC |
| ProjectIds | 否 | 否 | Array of Int64 | 根据项目ID过滤 |
| ViewNames | 否 | 否 | Array of String | 根据策略类型过滤 |
| AlarmStatus | 否 | 否 | Array of Int64 | 根据告警状态过滤 |
| ObjLike | 否 | 否 | String | 根据告警对象过滤 |
| InstanceGroupIds | 否 | 否 | Array of Int64 | 根据实例组ID过滤 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Alarms | DescribeBasicAlarmListAlarms | 告警列表 |
| Total | Int64 | 总数 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InternalError | |
| InvalidParameter | |
| MissingParameter | |
| LimitExceeded |