ARMS提供应用监控、前端监控、Prometheus监控、自定义监控和报警的API。本文列出了全部API文档链接及API功能说明。

应用监控

API 描述
ListTraceApps 获取指定地域下全部应用监控任务的列表。
ConfigApp 打开或关闭应用监控的Agent总开关，或者查询Agent总开关的状态。
DeleteTraceApp 删除应用。
SearchTraceAppByName 按应用名称查询应用监控任务。
SearchTraceAppByPage 分页查询应用监控任务。
SearchTraces 查询调用链列表信息，可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。
SearchTracesByPage 分页查询调用链列表信息，可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。
GetTrace 获取调用链详情。
GetMultipleTrace 获取多个调用链的详情。
QueryMetricByPage（应用监控） 分页查询应用监控的相关监控指标。
SaveTraceAppConfig 进行应用监控的自定义设置（如调用链采样设置、Agent开关等）。

前端监控

API 描述
CreateRetcodeApp 创建前端监控任务。
DeleteRetcodeApp 删除前端监控任务。
ListRetcodeApps 获取指定地域下全部前端监控任务的列表。
SearchRetcodeAppByPage 分页查询前端监控任务。
SetRetcodeShareStatus 打开或关闭前端监控站点的免登录分享开关。
GetRetcodeShareUrl 获取前端监控站点的分享地址。
QueryMetricByPage（前端监控） 分页查询前端监控的相关监控指标。

Prometheus监控

API 描述
AddGrafana 集成ARMS Prometheus监控的大盘。
AddIntegration 集成ARMS Prometheus监控的大盘以及采集规则。
GetPrometheusApiToken 获取集成ARMS Prometheus监控所需的Token。
ListDashboards 获取集群的Grafana大盘的列表。

自定义监控

API 描述
QueryDataset（通用数据集） 查询通用数据集中的数据。
QueryDataset（下钻数据集） 查询下钻数据集中的数据。

报警

API 描述
ImportAppAlertRules 导入应用监控或前端监控报警规则。
DeleteAlertRules 删除报警规则。
SearchAlertRules 查询报警规则。
StartAlert 启动报警规则。
StopAlert 停止报警规则。
CreateAlertContact 创建报警联系人。
DeleteAlertContact 删除报警联系人。
UpdateAlertContact 更新报警联系人。
SearchAlertContact 查询报警联系人。
CreateAlertContactGroup 创建报警联系人分组。
DeleteAlertContactGroup 删除报警联系人分组。
UpdateAlertContactGroup 更新报警联系人分组。
SearchAlertContactGroup 查询报警联系人分组。
SearchAlertHistories 查询报警规则的报警发送记录。
SearchEvents 查询报警事件记录。