API 概覽 - Application Real-Time Monitoring Service

API標準及多語言預置SDK

本產品（ARMS/2019-08-08）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：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、用户体验监控四大产品用量数据。