You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
合作与生态
支持与服务
开发者
了解我们
导航

PCAlarmRuleList

更新时间:2022.11.16 11:11:10

调用PCAlarmRuleList接口查看报警列表。

请求参数

Query

参数类型是否必选示例值描述
ActionStringPCAlarmRuleList请求名称
VersionString2022-10-28请求版本

Body

参数类型是否必选示例值描述
commonobject of common-通用参数
statusi80监控状态
  • 0:status_open
  • 1:status_close:
  • selfi81管理状态
  • 0:全部不传
  • 1:我管理的
  • category_listarray of string[pc_crash]报警类型
  • pc_flexible
  • pc_crash
  • keywordstringalarm搜索名称关键字
    page_sizei323每页规则数
    page_numi321返回页码号

    common

    参数类型是否必选示例值描述
    aidi6412345App ID
    envstringcrash环境信息
    osstringpc系统

    返回参数

    参数类型示例值描述
    dataobject of data-返回内容
    errmsgstring""错误信息,成功为空
    errnoi32200错误码,成功为 200

    data

    参数类型示例值描述
    alarm_rule_listarray of alarm_rule_list[ {"alarm_param":{...},"created_by": "root", "updated_by": "root" },...]报警规则列表
    counti3230报警规则总数

    alarm_rule_list

    参数类型示例值描述
    alarm_paramobject of alarm_param-报警参数
    created_bystringzhangsan创建人
    updated_bystringlisi更新人
    created_timei641667550612创建时间
    updated_timei641667550612更新时间
    next_trigger_timei641667550612下次触发时间
    last_execute_timei641668550612上次执行时间
    ack_until_timei641667550612ACK到期时间
    num_of_alarm_in_last_one_monthi32-上个月触发次数

    alarm_param

    参数类型示例值描述
    idi641创建时不传,更新时传
    namestringminitor报警名称
    descstring新的报警报警说明
    is_closei81是否关闭报警
  • 0:开启
  • 1:关闭
  • categorystringpc_flexible报警类型
    category_labelstring""报警类型展示名称
    alarm_levelstringWarn报警级别
  • Notice
  • Warn
  • Fatal
  • strategy_listarray of strategy_list[{id: "5422597736-1653918737621", measure: {type: "monomial",…},…}]报警策略
    strategy_opstringand多策略关系
  • and
  • or
  • interval_secondsi32300报警间隔,最短5分钟
    alarm_periodobject of alarm_period-报警时间
    notify_configobject of notify_config-报警通知
    pct_avoid_spikeobject of pct_avoid_spike-pct报警参数

    strategy_list

    参数类型示例值描述
    idstring9018754602-1655285699772当新建报警策略的时候前端生成,用于后端画趋势图
    measureobject of measure-指标集合
    filter_listarray of filter_list[{op: "in", filter_name: "os", values: ["1"]}]过滤条件
    alarm_strategy_typestringthreshold指标计算策略
  • 阈值:threshold
  • 同比:cmp_last_n_day
  • daily_compare_counti3260同比支持过去x分钟
    alarm_thresholddouble10报警阈值
    threshold_cmp_opstringgt报警阈值的op
  • gt
  • gte
  • lt
  • lte
  • abs_gt
  • abs_gte
  • alarm_sample_thresholddouble3样本数量阈值
    alarm_window_sizei64180时间窗口,单位s
    group_bysarray of group_bys[{type: "", group_by_name: "os", label: "OS", group_by_number_terms: null},…]报警的分组
    sample_metricobject of sample_metric-简单指标
    user_metricobject of user_metric-自定义指标

    alarm_period

    参数类型示例值描述
    start_timei320开始时间,单位秒
    end_timei3286399结束时间,单位秒

    notify_config

    参数类型示例值描述
    notify_typesarray of string["mail"]报警通知方式
  • lark
  • mail
  • wechat
  • dingding
  • notify_lark_webhooksarray of string["http://lark/url"]飞书通知webhook列表
    notify_groupsarray of string[1,23]邮件接收组ID列表
    notify_wechat_webhooksarray of string["http://wechat/url"]企业微信通知webhook列表
    notify_dingding_webhooksarray of string["http://dingding/url"]钉钉通知webhook列表
    upgrade_groupsarray of string[1,23]升级邮件接收组ID列表

    pct_avoid_spike

    参数类型示例值描述
    pcti810
  • 10:pct10
  • 20:pct20
  • alarm_thresholddouble10报警阈值

    measure

    参数类型示例值描述
    typestringmonomial指标类型
  • monomial
  • polynomial
  • raw_measure_listarray of raw_measure_list[{measure_name: "pc_crash_sink_chtb.user_ratio", filter_list: [], event_name: ""}]具体查询指标
    namestring崩溃影响用户数指标名称
    customIdstringxe3ejx98前端用于还原页面

    filter_list

    参数类型示例值描述
    opstringin过滤方式
    filter_namestringcpu用于表明filter的哪个维度
    valuesarray of string["intel", "Qualcomm"]过滤值

    group_bys

    参数类型示例值描述
    group_by_namestringos分组维度
    labelstringOS分组展示名称

    sample_metric

    参数类型示例值描述
    typestringmonomial指标类型
  • monomial
  • polynomial
  • raw_measure_listarray of raw_measure_list[{measure_name: "pc_crash_sink_chtb.user_ratio", filter_list: [], event_name: ""}]具体查询指标
    namestring崩溃影响用户数指标名称
    customIdstringxe3ejx98前端用于还原页面

    user_metric

    参数类型示例值描述
    typestringmonomial指标类型
  • monomial
  • polynomial
  • raw_measure_listarray of raw_measure_list[{measure_name: "pc_crash_sink_chtb.user_ratio", filter_list: [], event_name: ""}]具体查询指标
    namestring崩溃影响用户数指标名称
    customIdstringxe3ejx98前端用于还原页面

    raw_measure_list

    参数类型示例值描述
    measure_namestring"{\metric\:\pc_flexible.count\,\event_dimension\:\pc_flexible.event_name\,\event_name\:\test_service_gyf\}"具体的指标计算值
    filter_listarray of filter_list[]过滤条件
    event_namestringtest_service_gyf前端传了此参数, 后端没有用到,但是还原图表的时候是从这个字段读的事件名

    示例

    请求示例

    POST /?Action=PCAlarmRuleList&Version=2022-10-28 
    {
        "common": {
            "aid": 12345,
            "os": "pc",
            "env": "crash",
            "site_type": "nuclear"
        },
        "page_size": 3,
        "page_num": 1,
        "keyword": "alarm",
        "self": 1,
        "status": 250,
        "category_list": "[pc_crash]"
    }

    正常返回示例

    {
        "errno": 200,
        "data": {
            "count": 30,
            "alarm_rule_list": "[ {\"alarm_param\":{...},\"created_by\": \"root\", \"updated_by\": \"root\" },...]"
        },
        "errmsg": ""
    }

    异常返回示例

    {
        "ResponseMetadata": {
            "RequestId": "201806041104200100100232280022D30",
            "Action": "PCAlarmRuleList",
            "Version": "2022-10-28",
            "Service": "***",
            "Region": "cn-north-1",
            "Error": {
                "Code": "200000",
                "Message": "参数异常"
            }
        }
    }