API标准及多语言预置SDK
本产品(应用实时监控服务ARMS/2019-08-08)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。
用户体验监控
| API | 标题 | API概述 |
|---|---|---|
| UpdateRumFileStatus | 更新RUM文件状态 | 更新RUM文件状态,上传RUM文件成功后,调用此接口。 |
| GetRumUploadFiles | 获取RUM文件 | 获取RUM相关文件,包括符号表、SourceMap等。 |
| GetRumDataForPage | 分页获取RUM数据 | 分页获取RUM数据。 |
| CreateRumUploadFileUrl | 创建RUM文件上传链接 | 用于上传SourceMap文件、符号表文件等。 |
| DeleteRumUploadFile | 删除RUM文件 | 用于删除符号表、SourceMap等文件。 |
| GetRumAppInfo | 获取RUM应用信息 | 获取前端监控单个应用信息。 |
| GetRumApps | 获取RUM应用列表 | 获取RUM应用列表。 |
| CreateRumApp | 创建RUM应用 | 创建RUM应用。 |
| DeleteRumApp | 删除RUM应用 | 删除RUM应用。 |
| UpdateRumApp | 更新RUM应用 | 更新RUM应用。 |
| GetRumExceptionStack | 获取RUM异常堆栈信息 | 获取RUM异常堆栈信息。 |
访问控制
| API | 标题 | API概述 |
|---|---|---|
| OpenArmsServiceSecondVersion | 开通ARMS | 开通ARMS下指定子产品的后付费功能。 |
| OpenXtraceDefaultSLR | 开通可观测链路 OpenTelemetry 版服务关联角色 | 开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace。 |
| OpenArmsDefaultSLR | 开通ARMS服务关联角色 | 开通ARMS服务关联角色AliyunServiceRoleForARMS。 |
| ChangeResourceGroup | ARMS资源转组 | 修改资源所属资源组。 |
| TagResources | 创建标签资源关系 | 用于给ARMS资源实例打标签。 |
| UntagResources | 删除标签资源关系 | 用于删除ARMS资源实例标签。 |
产品计费
| API | 标题 | API概述 |
|---|---|---|
| GetCommercialStatus | 获取商业化状态 | 查看当前账号是否开通对应产品的商业化版本。 |
| CheckCommercialStatus | 检查产品商业化状态 | 检查产品的商业化开通状态。 |
| GetRumOcuStatisticData | 获取RUM的OCU用量数据 | 获取RUM的OCU用量数据。 |