You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /
  • 应用性能监控全链路版

PCAlarmUpdate

最近更新时间：2024.05.07 20:48:37

首次发布时间：2022.11.15 20:38:48

我的收藏

调用PCAlarmUpdate接口修改报警。

请求说明

  • 请求方式：POST
  • 请求地址：/?Action=PCAlarmUpdate&Version=2022-10-28
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json

请求参数

Query

参数类型是否必选示例值描述
ActionString是PCAlarmUpdate接口名称。当前 API 的名称为 PCAlarmUpdate。
VersionString是2022-10-28接口版本。当前 API 的版本为 2022-10-28。

Body

参数类型是否必选示例值描述
commonObject of CommonParams是-通用参数。
alarm_param_listArray of AlarmParam是-报警参数。

CommonParams

参数类型是否必选示例值描述
osString是pc系统。
aidLong是12345App ID。
envString否crash环境信息。

AlarmParam

参数类型是否必选示例值描述
idLong否1创建时不传，更新时传。
descString是新的报警报警说明。
nameString是minitor报警名称。
categoryString是pc_flexible报警类型。

is_close

Integer

是

1

是否关闭报警。

  • 0：开启
  • 1：关闭

alarm_level

String

是

Warn

报警级别。

  • Notice
  • Warn
  • Fatal

strategy_op

String

是

and

多策略关系。

  • and
  • or
alarm_periodObject of AlarmPeriod是-报警时间段。
notify_configObject of NotifyConfig否-报警通知。
strategy_listArray of AlarmStrategy是-报警策略。
category_labelString否""报警类型展示名称。
interval_secondsInteger是300报警间隔，最短5分钟。

AlarmPeriod

参数类型是否必选示例值描述
end_timeInteger是86399报警结束时间，单位秒。
start_timeInteger是0报警开始时间，单位秒。

NotifyConfig

参数类型是否必选示例值描述

notify_types

Array of String

否

["mail"]

报警通知方式。

  • lark
  • mail
  • wechat
  • dingding
notify_groupsArray of Long否[1,23]邮件接收组ID列表。
upgrade_groupsArray of Long否[1,23]升级邮件接收组ID列表。
notify_lark_webhooksArray of String否["http://lark/url"]飞书通知webhook列表。
notify_wechat_webhooksArray of String否["http://wechat/url"]企业微信通知webhook列表。
notify_dingding_webhooksArray of String否["http://dingding/url"]钉钉通知webhook列表。

AlarmStrategy

参数类型是否必选示例值描述
idString是9018754602-1655285699772当新建报警策略的时候前端生成，用于后端画趋势图。
measureObject of FlexMeasure是-指标集合。
group_bysArray of FlexGroupBy否-报警的分组。
filter_listArray of FlexFilter否-过滤条件。
alarm_thresholdDouble是10报警阈值。

threshold_cmp_op

String

是

gt

报警阈值的op。

  • gt
  • gte
  • lt
  • lte
  • abs_gt
  • abs_gte
alarm_window_sizeLong是180时间窗口，单位s。

alarm_strategy_type

String

是

threshold

指标计算策略。

  • 阈值：threshold
  • 同比：cmp_last_n_day
daily_compare_countInteger否60同比支持过去x分钟。
alarm_sample_thresholdDouble否3样本数量阈值。

FlexMeasure

参数类型是否必选示例值描述
nameString是崩溃影响用户数指标名称。

type

String

是

monomial

指标类型。

  • monomial
  • polynomial
customIdString否xe3ejx98前端用于还原页面。
raw_measure_listArray of FlexRawMeasure是-具体查询指标。

FlexGroupBy

参数类型是否必选示例值描述
labelString否OS分组展示名称。
group_by_nameString是os分组维度。

FlexFilter

参数类型是否必选示例值描述
opString是in过滤方式。
valuesArray of String是["intel", "Qualcomm"]过滤值。
filter_nameString是cpu用于表明filter的哪个维度。

FlexRawMeasure

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

返回参数

参数类型示例值描述
dataStringsuccess返回结果。
errmsgString""错误信息，成功时为空。
errnoInteger200错误码，成功为200。

请求示例

POST /?Action=PCAlarmUpdate&Version=2022-10-28
{
    "common": {
        "aid": 12345,
        "os": "pc",
        "site_type": "",
        "env": "crash"
    },
    "alarm_param_list": [
        {
            "name": "minitor",
            "desc": "新的报警",
            "is_close": 1,
            "category": "pc_flexible",
            "alarm_level": "Warn",
            "strategy_list": [
                {
                    "id": "9018754602-1655285699772",
                    "alarm_strategy_type": "threshold",
                    "alarm_threshold": 10,
                    "threshold_cmp_op": "gt",
                    "alarm_window_size": 180,
                    "group_bys": [
                        {
                            "group_by_name": "os",
                            "label": "OS"
                        }
                    ],
                    "filter_list": [
                        {
                            "op": "in",
                            "filter_name": "cpu",
                            "values": [
                                "intel",
                                "Qualcomm"
                            ]
                        }
                    ],
                    "daily_compare_count": 60,
                    "alarm_sample_threshold": 3
                }
            ],
            "strategy_op": "and",
            "interval_seconds": 300,
            "alarm_period": {
                "start_time": 12,
                "end_time": 86399
            },
            "category_label": "",
            "notify_config": {
                "notify_groups": [
                    1,
                    23
                ],
                "upgrade_groups": [
                    1,
                    23
                ],
                "notify_wechat_webhooks": [
                    "http://wechat/url"
                ],
                "notify_types": [
                    "mail"
                ],
                "notify_lark_webhooks": [
                    "http://lark/url"
                ],
                "notify_dingding_webhooks": [
                    "http://dingding/url"
                ]
            },
            "id": 1
        }
    ]
}

返回示例

{
    "errmsg": "",
    "errno": 200,
    "data": "success"
}