You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
报警
QueryAlarmEventsWithPage
复制全文
下载 pdf
QueryAlarmEventsWithPage
获取 App 报警历史。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAppAlarmHistory&Version=2025-12-01​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数。​
说明​
调用本接口前,请在请求中传入必填的公共请求参数(如 x-app-ids),否则将调用失败。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
GetAppAlarmHistory​
接口名称。当前 API 的名称为 GetAppAlarmHistory。​
Version​
String​
是​
2025-12-01​
接口版本。当前 API 的版本为 2025-12-01。​
Aid​
Long​
是​
123456​
应用 ID。​
Filters​
Object of Condition​
否​
-​
筛选条件。​
StartTime​
Long​
是​
1665417600​
开始时间,Unix 时间戳(秒)。​
EndTime​
Long​
是​
1666417600​
结束时间,Unix 时间戳(秒)。​
QueryKey​
String​
是​
test​
报警事件名模糊搜索,不填默认全部。​
PageSize​
Long​
是​
2​
分页条数,不传默认 10。​
PageNo​
Long​
是​
1​
起始页码,从 1 开始。​
MonitorType​
String​
否​
crash​
异常类型。取值:​
  • crash:崩溃​
  • crash_defend:崩溃防护​
  • lag:卡顿​
  • flutter_crash:flutter 监控​
  • app_page_js_err:页面监控/js 错误​
  • app_page_ajax_err:页面监控/请求错误​
  • app_page_perf:页面监控/性能​
  • app_event:事件报警​
  • net_err:网络错误​
  • custom_exception:自定义错误​
MonitorTypes​
Array of String​
否​
-​
异常类型列表。取值:​
  • crash:崩溃​
  • crash_defend:崩溃防护​
  • lag:卡顿​
  • flutter_crash:flutter 监控​
  • app_page_js_err:页面监控/js 错误​
  • app_page_ajax_err:页面监控/请求错误​
  • app_page_perf:页面监控/性能​
  • app_event:事件报警​
  • net_err:网络错误​
  • custom_exception:自定义错误​
OrderBy​
String​
否​
-occur_time​
排序方式,默认按报警时间倒序。​
​
Condition​
​
参数​
类型​
是否必选​
示例值​
描述​
Op​
String​
否​
in​
操作符。取值:​
  • gt:大于​
  • gte:大于等于​
  • lt:小于​
  • lte:小于等于​
  • eq:等于​
  • neq:不等于​
  • in:包含​
  • not_in:不包含​
  • lk:模糊匹配特定模式的数据​
  • nlk:排除模糊匹配的数据​
Type​
String​
否​
expression​
筛选条件类型。示例值:​
  • expression:当前条件为单一表达式。​
  • and:当前条件为复合表达式,各子条件 SubConditions 之间为逻辑“与”关系。​
  • or:当前条件为复合表达式,各子条件 SubConditions 之间为逻辑“或”关系。​
  • map:当前条件为 map 类型。​
Value​
String​
否​
123456​
筛选值。​
MapKey​
String​
否​
key_1​
map 类型的 key。​
说明​
当 type取值为 map 时,必须配置此参数。​
Values​
Array of String​
否​
[123456]​
筛选值,支持同时配置多个。​
Dimension​
String​
否​
aid​
条件的名称。​
SubConditions​
Array of Condition​
否​
-​
子条件。​
​
请求示例​
​
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAppAlarmHistory&Version=2025-12-01​
{​
"Aid": 123456,​
"Filters": {​
"Op": "in",​
"Type": "expression",​
"Value": "123456",​
"MapKey": "key_1",​
"Values": [​
123456​
],​
"Dimension": "aid",​
"SubConditions": []​
},​
"StartTime": 1665417600,​
"EndTime": 1666417600,​
"QueryKey": "test",​
"PageSize": 2,​
"PageNo": 1,​
"MonitorType": "crash",​
"MonitorTypes": [​
""​
],​
"OrderBy": "-occur_time"​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
Data​
Array of AlarmEvent​
[]​
报警历史列表。​
CurrPage​
Long​
1​
当前页码。​
TotalCnt​
Long​
0​
总条数。​
TotalPage​
Long​
0​
总页数。​
​
AlarmEvent​
​
参数​
类型​
示例值​
描述​
Id​
Long​
1​
报警事件 ID。​
Url​
String​
https://example.com/detail​
报警详情链接。​
RuleId​
Long​
1​
报警任务 ID。​
AckTime​
String​
​
ACK 时间。​
HitRule​
Object of AlarmHitRule​
-​
报警任务规则配置。​
RuleName​
String​
test​
报警名称。​
AckStatus​
Long​
0​
ACK 状态。取值:​
  • 0:可确认​
  • 1:可重置​
OccurTime​
String​
2022-10-18 21:52:30​
报警事件发生时间。​
Operators​
Array of String​
[]​
报警创建人 ID 列表。​
RuleBrief​
String​
​
报警事件对应规则简述。​
AlarmLevel​
String​
warning​
报警级别。取值:​
  • warning​
  • fatal​
FilterInfo​
Object of FilterCondition​
-​
报警任务筛选条件。​
MonitorType​
String​
crash​
异常类型。​
NotifyTypes​
Array of String​
["mail"]​
通知方式。​
HandleStatus​
Long​
0​
处理状态。​
AlarmReceives​
Array of Candidate​
[]​
报警邮件接收组信息。​
NotifyContent​
String​
-​
报警内容。​
OperatorsInfo​
Array of UserProfile​
[]​
报警创建人具体信息。​
​
AlarmHitRule​
​
参数​
类型​
示例值​
描述​
Op​
String​
gt​
比较符。取值:​
  • gt:大于​
  • gte:大于等于​
  • lt:小于​
  • lte:小于等于​
  • eq:等于​
Type​
String​
and​
筛选条件类型。示例值:​
  • expression:当前条件为单一表达式。​
  • and:当前条件为复合表达式,各子条件 SubConditions 之间为逻辑“与”关系。​
  • or:当前条件为复合表达式,各子条件 SubConditions 之间为逻辑“或”关系。​
Indicator​
Object of Indicator​
-​
阈值类型指标配置。​
Indicators​
Array of Indicator​
-​
同环比类型指标配置。​
SubHitRule​
Object of AlarmHitRule​
-​
子规则。​
HitRuleType​
String​
threshold​
命中规则类型。取值:​
  • threshold:阈值​
  • compare:同环比​
SubHitRules​
Array of AlarmHitRule​
[]​
子规则列表。​
ThresholdValue​
Double​
10000​
报警阈值。​
ThresholdCalculateType​
String​
-​
阈值计算方式,支持加减或百分比。​
​
FilterCondition​
​
参数​
类型​
示例值​
描述​
Op​
String​
in​
操作符。取值:​
  • gt:大于​
  • gte:大于等于​
  • lt:小于​
  • lte:小于等于​
  • eq:等于​
  • neq:不等于​
  • in:包含​
  • not_in:不包含​
  • lk:模糊匹配特定模式的数据​
  • nlk:排除模糊匹配的数据​
Type​
String​
and​
条件类型。示例值:​
  • expression:当前条件为单一表达式。​
  • and:当前条件为复合表达式,各子条件 SubConditions 之间为逻辑“与”关系。​
  • or:当前条件为复合表达式,各子条件 SubConditions 之间为逻辑“或”关系。​
Value​
String​
123456​
单个操作数。​
Values​
Array of String​
[123456]​
操作数列表。​
Dimension​
String​
aid​
条件维度名称。​
SubCondition​
Object of FilterCondition​
-​
子条件。​
SubConditions​
Array of FilterCondition​
-​
子条件列表。​
​
Candidate​
​
参数​
类型​
示例值​
描述​
Email​
String​
test@test.com​
用户邮箱。​
GroupId​
Integer​
1​
接收组 ID。​
IsGroup​
Boolean​
true​
是否接收组。​
UserName​
String​
test​
用户名。​
GroupName​
String​
test​
接收组名。​
​
UserProfile​
​
参数​
类型​
示例值​
描述​
Id​
Long​
1​
用户 ID。​
Email​
String​
test@test.com​
用户邮箱。​
Username​
String​
test_name​
用户名。​
SsoUserId​
String​
123456​
SSO 用户 ID。​
​
Indicator​
​
参数​
类型​
示例值​
描述​
Name​
String​
crash_count​
指标定义名称,由 GetAppAlarmMetricsConf 接口获取。​
Value​
Double​
10​
指标值。​
EndTime​
Long​
1665417900​
统计结束时间。​
Recently​
Long​
180​
指标查询时间范围,单位:分钟。​
StartTime​
Long​
1665417600​
统计起始时间的时间戳。​
CompareTime​
Long​
0​
比较时间。取值:​
  • 5:前五分钟​
  • 0:当前​
​
返回示例​
​
{​
"ResponseMetadata": {​
"Action": "GetAppAlarmHistory",​
"Region": "cn-north-1",​
"Service": "apmplus_openapi",​
"Version": "2025-12-01",​
"RequestId": "20230604110420****100232280022D31"​
},​
"Result": {​
"Data": [],​
"CurrPage": 1,​
"TotalCnt": 0,​
"TotalPage": 0​
},​
"-": {​
"Data": [],​
"CurrPage": 1,​
"TotalCnt": 0,​
"TotalPage": 0​
}​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.10.21 16:47:31
这个页面对您有帮助吗?
有用
有用
无用
无用