API接口参考大全分类说明-应用实时监控服务-阿里云-应用实时监控服务(ARMS)-阿里云帮助中心

API标准及多语言预置SDK

本产品（ARMS/2019-08-08）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

监控指标

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。
ChangeResourceGroup	ARMS资源转组	修改资源所属资源组。
TagResources	创建标签资源关系	用于给ARMS资源实例打标签。
UntagResources	删除标签资源关系	用于删除ARMS资源实例标签。

产品计费

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