查询告警策略列表

最近更新时间: 2024-10-18 10:38:29

1. 接口描述

接口请求域名: monitor.api3.fincloud.tencent.cn。

查询告警策略列表

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

接口更新时间:2022-06-28 11:20:11。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeAlarmPolicies
Version String 公共参数,本接口取值:2018-07-24
Region String 公共参数,详见产品支持的地域列表(TODO)
Module String 固定值,为"monitor"
PageNumber Int64 页数,从 1 开始计数,默认 1
PageSize Int64 每页的数量,取值1~100,默认20
PolicyName String 按策略名称模糊搜索
MonitorTypes Array of String 根据监控类型过滤 不选默认查所有类型 "MT_QCE"=云产品监控
Namespaces Array of String 根据命名空间过滤
Measurements Array of String 根据策略类型(viewName)过滤 (云产品监控用)
Dimensions String 告警对象列表
ReceiverUids Array of Int64 根据接收人搜索
ReceiverGroups Array of Int64 根据接收组搜索
PolicyType Array of String 根据默认策略筛选 不传展示全部策略 DEFAULT=展示默认策略 NOT_DEFAULT=展示非默认策略
Field String 排序字段
Order String 排序顺序:升序:ASC 降序:DESC
ProjectIds Array of Int64 项目id数组
AlarmStatus Array of Int64 字段废弃,启停,1:启用 0:停止
NoticeIds Array of String 告警通知id列表
RuleTypes Array of String 根据触发条件筛选 不传展示全部策略 STATIC=展示静态阈值策略 DYNAMIC=展示动态阈值策略
Enable Array of Int64 启停,1:启用 0:停止
NotBindingNoticeRule Int64 是否未配置通知规则,1:未配置,0:配置
InstanceGroupId Int64 实例组id
ConditionTemplateId Int64 条件模板id
Like String 模糊匹配
Limit String 限制
Offset Int64 偏移量

3. 输出参数

参数名称 类型 描述
TotalCount Int64 策略总数
Policies AlarmPolicy 策略数组
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
UnsupportedOperation
InternalError
FailedOperation