租户端 运维工具 云监控(BARAD) 告警相关接口 MiniDashboard 拉取一个实例的告警相关信息

MiniDashboard 拉取一个实例的告警相关信息

最近更新时间: 2024-09-03 18:50:00

1. 接口描述

接口请求域名: monitor.api3.cloud.sunhongs.com。

MiniDashboard 拉取一个实例的告警相关信息

默认接口请求频率限制:20次/秒。

接口更新时间:2023-05-23 19:20:49。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeMiniDashboardAlarmInfo
Version String 公共参数,本接口取值:2018-07-24
Region String 公共参数,详见产品支持的地域列表(TODO)
StartTime Int64 起始时间
EndTime Int64 结束时间
MonitorType String 监控类型 MT_QCE=云产品监控
Namespace String 告警namespace,用于区分云产品
Dimensions String 云产品的实例信息,json格式
Module String 固定值,为"monitor"
SevenDaysStartTime Int64 七天前告警总数的开始时间

3. 输出参数

参数名称 类型 描述
AlarmCountInSevenDays Int64 七天内的告警个数
AlarmHistory AlarmHistory 指定时间段内的告警历史
AlarmMetrics AlarmHistoryMetric 告警历史对应的告警指标
PoliciesInfo MiniDashboardAlarmInfo 实例是否有策略的相关信息
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
ResourceNotFound
UnsupportedOperation
FailedOperation