本产品（
应用实时监控服务ARMS/2019-08-08）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
可观测监控 Prometheus 版
| API | 标题 | API概述 |
|---|---|---|
| DescribeEnvDropMetricsRule | 查询接入环境的废弃指标规则 | 查询指定环境实例的废弃指标列表 |
| UpdateEnvDropMetricsRule | 更新环境中废弃指标规则 | 更新环境中废弃指标规则。 |
| DescribeAddonMetrics | 查询Addon指标信息 | 查询指定Addon的指标详情。 |
| ListEnvironmentKubeResources | 查看环境的K8s资源 | 查看环境的K8s资源。 |
| ListEnvironmentMetricTargets | 查询环境中的Target列表 | 查询环境中的Target列表。 |
| ListEnvironmentAddons | 查询指定环境安装的Addon | 查询指定环境安装的Addon信息。 |
| ListEnvironmentAlertRules | 查询环境中的告警组信息 | 查询环境中的告警组信息。 |
可观测可视化 Grafana 版
| API | 标题 | API概述 |
|---|---|---|
| ListGrafanaWorkspace | 获取Grafana工作区列表 | 获取地域内Grafana工作区列表。 |
| GetGrafanaWorkspace | 查询Grafana工作区信息 | 查询指定Grafana工作区信息。 |
| CreateGrafanaWorkspace | 创建Grafana工作区 | 创建可观测可视化 Grafana 版工作区实例。 |
| UpdateGrafanaWorkspace | 更新Grafana工作区 | 更新指定Grafana工作区信息。 |
| UpdateGrafanaWorkspaceVersion | 更新Grafana工作区版本 | 更新Grafana工作区版本。 |
| DeleteGrafanaWorkspace | 删除Grafana工作区 | 删除可观测可视化 Grafana 版工作区实例。 |
访问控制
| API | 标题 | API概述 |
|---|---|---|
| OpenArmsServiceSecondVersion | 开通ARMS | 开通ARMS下指定子产品的后付费功能。 |
| OpenXtraceDefaultSLR | 开通可观测链路 OpenTelemetry 版服务关联角色 | 开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace。 |
| OpenArmsDefaultSLR | 开通ARMS服务关联角色 | 开通ARMS服务关联角色AliyunServiceRoleForARMS。 |
| ChangeResourceGroup | ARMS资源转组 | 修改资源所属资源组。 |
| TagResources | 创建标签资源关系 | 用于给ARMS资源实例打标签。 |
| UntagResources | 删除标签资源关系 | 用于删除ARMS资源实例标签。 |