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概述
GetTraceApp	获取应用监控任务详情	获取应用监控任务详情。
GetAppJVMConfig	获取应用各个实例的JVM配置信息	获取应用各个实例的JVM配置信息。
QueryAppTopology	查询拓扑图	查询应用拓扑。
GetAppApiByPage	查询接口的黄金三指标数据	通过分页的形式查询应用下每个接口的请求量、错误数、平均响应时间三种性能数据。可通过返回信息中的Completed字段判断分页是否结束。如未结束，CurrentPage参数加一后继续发起查询即可。
GetTrace	获取调用链详情	加快获取调用链详情。
GetStack	获取调用链方法栈	获取调用链方法栈信息。
GetMultipleTrace	获取多个调用链详情	获取多个调用链的详情。
ConfigApp	打开或关闭应用监控总开关	打开或关闭应用监控的Agent总开关，或者查询Agent总开关的状态。
SaveTraceAppConfig	应用监控自定义设置	进行应用监控的自定义设置（如调用链采样设置、Agent开关等）。
GetTraceAppConfig	查询应用监控自定义设置	查询应用监控中，某个应用的全部自定义设置（如调用链采样设置、Agent开关等）。此接口仅适用于接入应用监控的应用，不适用于接入可观测链路 OpenTelemetry 版的应用。
DeleteTraceApp	删除指定ID和类型的应用	删除指定ID或类型的应用。
QueryReleaseMetric	查看不同版本的指标	查询EDAS和K8s应用发布过程中不同版本的指标。
ListTraceApps	获取指定地域下全部应用监控任务的列表	获取指定地域下全部应用监控任务的列表。
SearchTraceAppByName	按应用名称查询应用监控任务	按应用名称查询应用监控任务。
SearchTraceAppByPage	分页查询应用监控任务	分页查询应用监控任务。
SearchTraces	查询调用链列表信息	查询调用链列表信息，可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。
SearchTracesByPage	分页查询调用链列表信息	分页查询调用链列表信息，可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。
GetAgentDownloadUrlV2	获取探针下载链接V2	获取探针下载地址。
GetAgentDownloadUrl	获取探针下载链接	获取探针下载链接。
DescribeTraceLicenseKey	列出LicenseKey	列出LicenseKey。
ListInsightsEvents	查询异常事件列表	查询指定时间段内Insights的异常事件列表。
QueryAppMetadata	查询编码映射内容	根据ID和类型查询编码映射内容。
DeleteAppList	批量删除应用	根据应用监控PID列表，批量删除应用。
DoInsightsAction	访问Insights相关的各种子功能	根据参数指定的模块类型，执行相应的动作。

访问控制

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、用户体验监控四大产品用量数据。