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

应用监控

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

前端监控

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

Prometheus监控

API 描述
AddGrafana 集成ARMS Prometheus监控的大盘。
AddIntegration 集成ARMS Prometheus监控的大盘以及采集规则。
GetPrometheusApiToken 获取集成ARMS Prometheus监控所需的Token。
ListDashboards 获取集群的Grafana大盘的列表。
CreatePrometheusAlertRule 创建告警规则。
UpdatePrometheusAlertRule 更新告警规则。
ListPrometheusAlertRules 查看Prometheus告警规则列表。