文档中心

应用性能监控全链路版

请输入

报警

GetAlarmDistribution

获取报警类型分布。

请求说明

客户端监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmDistribution&Version=2022-10-12

请求参数

下方仅列出该接口特有的请求参数和部分公共参数，更多详细信息参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	GetAlarmDistribution	接口名称。当前 API 的名称为 GetAlarmDistribution。
Version	String	是	2022-10-12	接口版本。当前 API 的版本为 2022-10-12。
common	Object of Common	否	-	通用参数。
time_filter	Object of TimeFilter	否	-	时间区间。
name_list	Array of String	否	111	报警任务名称列表。不填时返回全部名称报警历史。调用GetAlarmRuleList接口查看取值。
level_list	Array of String	否	warning	报警级别列表。不填时返回全部类型报警。 warning fatal
category_list	Array of String	否	pageview	报警类型。不填时返回全部类别报警历史。调用GetAlarmMeta接口查看取值。

Common

参数	类型	是否必选	示例值	描述
aid	Long	否	12345	应用ID。
os	String	否	webpro	服务类型。

TimeFilter

参数	类型	是否必选	示例值	描述
start_time	Integer	否	1665849600	起始时间。
granularity	Integer	否	60	聚合时间粒度。单位s。
end_time	Integer	否	1666011403	终止时间。

请求示例

POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmDistribution&Version=2022-10-12​
{​
    "common":{​
        "aid":12345,​
        "os":"webpro"​
    },​
    "time_filter":{​
        "start_time":1665849600,​
        "end_time":1666011403,​
        "granularity":3600​
    },​
    "page_size":10,​
    "page_num":1,​
    "category_list":[​
        "pageview"​
    ],​
    "name_list":[​
        "111111111"​
    ],​
    "level_list":[​
        "warning"​
    ]​
}

返回参数

参数	类型	示例值	描述
data	Array of Data	-	返回数据。
error_msg	String	""	错误信息。成功为""。
error_no	Integer	0	错误码。成功为0。

Data

参数	类型	示例值	描述
category	String	pageview	报警任务类别。
count	Long	1407	该类型报警次数。
percent	Double	1	该类别报警次数占总报警占比。

返回示例

{​
    "err_detail":"",​
    "data":"all-history_xxx-xxx.xlsx",​
    "error_msg":"",​
    "error_no":0​
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

最近更新时间：2026.08.28 16:25:33

这个页面对您有帮助吗？

有用

无用