全部产品
Search
文档中心

应用实时监控服务ARMS:API概览

更新时间:Apr 26, 2024
本产品(应用实时监控服务ARMS/2019-08-08)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

监控指标

API标题API概述
QueryMetricByPage查询监控指标分页查询应用监控或前端监控的相关监控指标。

前端监控

API标题API概述
Upload上传SourceMap上传SourceMap到ARMS前端监控。
DeleteSourceMap删除SourceMap文件删除前端监控中上传的SourceMap文件。
GetSourceMapInfo获取SourceMap文件详细信息获取前端监控中上传的SourceMap文件详细信息。
CreateRetcodeApp创建前端监控任务创建前端监控任务。
GetRetcodeShareUrl获取前端监控站点的分享地址获取前端监控站点的分享地址。
DeleteRetcodeApp删除前端监控任务删除前端监控任务。
SetRetcodeShareStatus打开或关闭前端监控站点的免登录分享开关打开或关闭前端监控站点的免登录分享开关,打开该功能后即可通过调用GetRetcodeShareUrl接口获取的地址访问前端监控页面。
ListRetcodeApps列出所有前端监控任务列出指定地域下所有前端监控任务。
SearchRetcodeAppByPage分页查询前端监控任务分页查询前端监控任务。
GetRetcodeLogstore获取Project和Logstore获取指定账号下前端监控应用对应SLS存储的Project和Logstore。
GetRetcodeDataByQuery根据SLS查询语句获取前端监控数据根据SLS的查询语句查询前端监控的数据。
GetRetcodeAppByPid根据Pid获取前端监控应用根据前端监控应用Pid返回前端监控应用对象。

访问控制

API标题API概述
OpenArmsServiceSecondVersion开通ARMS开通ARMS下指定子产品的后付费功能。
OpenXtraceDefaultSLR开通可观测链路 OpenTelemetry 版服务关联角色开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace。
OpenArmsDefaultSLR开通ARMS服务关联角色开通ARMS服务关联角色AliyunServiceRoleForARMS。
ChangeResourceGroupARMS资源转组修改资源所属资源组。
TagResources创建标签资源关系用于给ARMS资源实例打标签。
UntagResources删除标签资源关系用于删除ARMS资源实例标签。

产品计费

API标题API概述
GetCommercialStatus获取商业化状态获取商业化状态。
CheckCommercialStatus检查产品商业化状态检查产品的商业化开通状态。
QueryCommercialUsage查询可观测用量数据查询写入量数据,支持应用监控、可观测链路OpenTelemetry版、Prometheus、用户体验监控四大产品用量数据。