API标准及多语言预置SDK
本产品(应用实时监控服务ARMS/2019-08-08)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求,需通过自签名方式对接 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概述 |
|---|---|---|
| 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概述 |
|---|---|---|
| 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异常堆栈信息。 |
可观测监控 Prometheus 版
| API | 标题 | API概述 |
|---|---|---|
| DescribeEnvDropMetricsRule | 查询接入环境的废弃指标规则 | 查询指定环境实例的废弃指标列表 |
| UpdateEnvDropMetricsRule | 更新环境中废弃指标规则 | 更新环境中废弃指标规则。 |
| AddTagToFlinkCluster | Prometheus Flink集群打标 | 主要将用户Flink工作空间对应的Prometheus实例打上工作空间ID、工作空间名称这两个Tag。 |
| CreateEnvironment | 创建环境 | 创建环境实例。 |
| InitEnvironment | 初始化环境实例 | 初始化环境实例。 |
| DescribeEnvironment | 查询环境详情 | 查询环境详情。 |
| UpdateEnvironment | 更新环境信息 | 更新环境信息。 |
| ListEnvironments | 查询环境列表 | 查询环境列表。 |
| DeleteEnvironment | 删除环境 | 删除环境实例。 |
| DescribeAddonMetrics | 查询Addon指标信息 | 查询指定Addon的指标详情。 |
| InstallEnvironmentFeature | 安装Feature | 安装Feature。 |
| DescribeEnvironmentFeature | 查询Feature详情 | 查询Feature详情。 |
| UpgradeEnvironmentFeature | 更新Feature | 更新Feature信息。 |
| RestartEnvironmentFeature | 重启Feature | 重启feature。 |
| ListEnvironmentFeatures | 查询环境中的Feature | 查询环境中的Feature。 |
| DeleteEnvironmentFeature | 删除feature | 删除feature。 |
| CreateEnvCustomJob | 创建环境的自定义Job | 创建环境的自定义Job。 |
| UpdateEnvCustomJob | 更新环境的自定义Job | 更新环境的自定义Job。 |
| ListEnvCustomJobs | 查询环境的自定义Job列表 | 查询环境的自定义Job列表。 |
| DescribeEnvCustomJob | 查询环境CustomJob详情 | 查询环境CustomJob详情。 |
| DeleteEnvCustomJob | 删除环境的自定义Job | 删除环境的自定义job。 |
| CreateEnvPodMonitor | 创建环境的PodMonitor | 创建环境的PodMonitor。 |
| DescribeEnvPodMonitor | 查询环境的PodMonitor详情 | 查询环境的PodMonitor详情。 |
| ListEnvPodMonitors | 查询环境的PodMonitor列表 | 查询环境的PodMonitor列表。 |
| UpdateEnvPodMonitor | 更新环境的PodMonitor | 更新环境的PodMonitor。 |
| DeleteEnvPodMonitor | 删除环境PodMonitor | 删除环境PodMonitor。 |
| CreateEnvServiceMonitor | 创建环境的ServiceMonitor | 创建环境的ServiceMonitor。 |
| DescribeEnvServiceMonitor | 查询环境的ServiceMonitor详情 | 查询环境的ServiceMonitor详情。 |
| ListEnvServiceMonitors | 查询环境的ServiceMonitor列表 | 查询环境的ServiceMonitor列表。 |
| UpdateEnvServiceMonitor | 更新环境的ServiceMonitor | 更新环境的ServiceMonitor。 |
| DeleteEnvServiceMonitor | 删除环境ServiceMonitor | 删除环境ServiceMonitor。 |
| InstallAddon | 安装Addon信息 | 安装Addon信息。 |
| DescribeAddonRelease | 查看AddonRelease详情 | 通过名称查询AddonRelease详情。 |
| ListAddons | 查询addon列表 | 新版接入中心产品列表。 |
| UpgradeAddonRelease | 更新AddonRelease信息 | 更新AddonRelease信息。 |
| ListAddonReleases | 查询环境中安装的Addon | 查询环境中安装的Addon。 |
| DeleteAddonRelease | 删除AddonRelease信息 | 通过AddonRelease名称删除AddonRelease数据。 |
| ListEnvironmentDashboards | 查询环境中的大盘信息 | 查询环境中的大盘信息。 |
| EnableMetric | 启用单个废弃指标 | 启用废弃指标。 |
| UpdateMetricDrop | 更新废弃指标列表 | 更新废弃指标列表。 |
| UpdatePrometheusMonitoringStatus | 更新Prometheus实例监控配置状态 | 更新Prometheus实例监控配置状态。 |
| UpdatePrometheusMonitoring | 更新Prometheus实例监控配置 | 更新Prometheus实例监控配置。 |
| ListPrometheusMonitoring | 查询Prometheus实例监控配置 | 查询Prometheus实例监控配置。 |
| GetPrometheusMonitoring | 查询Prometheus实例指定监控配置 | 查询Prometheus实例指定监控配置。 |
| DeletePrometheusMonitoring | 删除Prometheus实例监控配置 | 删除Prometheus实例监控配置。 |
| CreatePrometheusMonitoring | 创建Prometheus实例的监控配置 | 创建Prometheus实例的监控配置。 |
| AppendInstancesToPrometheusGlobalView | 新增Prometheus实例数据源 | 增加ARMS Prometheus监控聚合实例中的数据源,将数据源添加到Prometheus聚合实例。 |
| AddPrometheusInstance | 创建RemoteWrite类型的Prometheus实例 | 创建RemoteWrite类型Prometheus实例。 |
| AddPrometheusGlobalViewByAliClusterIds | 新增容器聚合实例 | 增加ARMS Prometheus监控的聚合实例。 |
| AddPrometheusGlobalView | 新增聚合实例 | 增加ARMS Prometheus监控的聚合实例。 |
| AddAliClusterIdsToPrometheusGlobalView | 新增聚合实例数据源 | 增加ARMS Prometheus监控聚合实例的数据源。 |
| AddRecordingRule | 创建RecordingRule | 创建或者更新Prometheus监控的RecordingRule规则。 |
| SyncRecordingRules | 将某个集群的聚合规则批量同步到全Region的其他目标集群 | 将某个集群的聚合规则批量同步到全Region的其他目标集群。 |
| AddIntegration | 集成大盘及采集规则 | 集成ARMS Prometheus监控的大盘以及采集规则。 |
| GetIntegrationState | 获取Integration的接入状态 | 来获取Integration的接入状态。 |
| DeleteIntegration | 删除Integration接入的采集规则 | 删除Integration接入的采集规则。 |
| AddGrafana | 集成Prometheus监控大盘 | 集成ARMS Prometheus监控的大盘。 |
| InstallCmsExporter | 安装云服务采集器 | 安装云服务采集器。 |
| OpenVCluster | 开通虚拟集群 | 开通虚拟集群。 |
| DeletePrometheusGlobalView | 删除Prometheus聚合实例 | 删除Prometheus聚合实例。 |
| RemoveAliClusterIdsFromPrometheusGlobalView | 删除聚合实例数据源 | 移除ARMS Prometheus监控聚合实例的某些数据源。 |
| RemoveSourcesFromPrometheusGlobalView | 删除聚合实例非阿里数据源 | 移除ARMS Prometheus监控聚合实例中的数据源,仅支持删除非阿里数据源。 |
| DeleteCmsExporter | 卸载Prometheus for 云服务实例 | 来卸载Prometheus for 云服务实例。 |
| DelAuthToken | 关闭鉴权token | 关闭鉴权token。 |
| DeleteGrafanaResource | 删除集群的大盘资源 | 删除ARMS Prometheus监控集群中的Grafana大盘资源。 |
| UninstallPromCluster | 卸载prometheus集群 | 来卸载ARMS Prometheus集群实例。 |
| QueryPromInstallStatus | 查询集群安装状态 | 来查询ARMS Prometheus集群的安装状态。 |
| ListPrometheusGlobalView | 获取聚合实例列表 | 增加ARMS Prometheus监控的聚合实例,获取聚合实例列表。 |
| GetPrometheusGlobalView | 获取聚合实例的数据源详情 | 增加ARMS Prometheus监控的聚合实例,获取指定聚合实例的详细数据源情况。 |
| CheckServiceStatus | 检查产品开通状态 | 检查集群当前的服务状态,例如是否开通服务,是否欠费等。 |
| GetPrometheusApiToken | 获取Prometheus监控所需Token | 获取集成ARMS Prometheus监控所需的Token。 |
| GetExploreUrl | 获取Grafana的Explore功能 | 获取使用Grafana的Explore功能。 |
| ListDashboards | 获取集群的大盘列表 | 获取集群的Grafana大盘的列表。 |
| ListClusterFromGrafana | 列出指定地域下的所有Grafana大盘 | 列出指定地域下的所有Grafana大盘。 |
| GetRecordingRule | 获取聚合规则 | 获取集群的RecordingRule聚合规则。 |
| ListCmsInstances | 查询云服务采集状态 | 查询云服务采集状态。 |
| ListDashboardsByName | 创建Loki数据源和相关的多数据源大盘 | 来创建与Prometheus关联的Loki数据源和相关的多数据源大盘。 |
| GetAuthToken | 获取公网读写鉴权 | 获取公网读写鉴权Token。 |
| GetClusterAllUrl | 获取集群所有地址 | 获取集群所有地址。包括远程读写地址、 Push Gateway地址、 Grafana地址。 |
| GetCloudClusterAllUrl | 获取云产品各种URL | 获取云监控云产品读写地址,pushgateway,grafana 地址。 |
| ListPrometheusInstances | 获取所有正常实例 | 获取Prometheus的所有正常实例。 |
| InstallManagedPrometheus | 创建托管Prometheus | 创建托管(ASK/ECS)Prometheus。 |
| UninstallManagedPrometheus | 卸载托管Prometheus | 卸载托管(ASK/ECS/ACKoNE)Prometheus。 |
| GetManagedPrometheusStatus | 获取托管版Prometheus安装状态 | 获取托管版(ask、ecs和one)Prometheus实例的安装状态。 |
| BindPrometheusGrafanaInstance | 绑定Prometheus实例使用的Grafana工作区ID | 绑定Prometheus实例使用的Grafana工作区ID。 |
| AddPrometheusIntegration | 增加Prometheus实例的集成中心Exporter实例 | 增加Prometheus实例的集成中心Exporter实例(仅支持aliyun-cs、ecs两种类型的实例)。 |
| UpdatePrometheusIntegration | 更改Prometheus实例集成中心Exporter配置 | 更改Prometheus实例(仅支持aliyun-cs、ecs两种类型的实例)集成中心Exporter配置。 |
| DeletePrometheusIntegration | 删除Prometheus实例集成中心Exporter实例 | 删除Prometheus实例集成中心Exporter实例(仅支持aliyun-cs、ecs两种类型的实例)。 |
| GetPrometheusIntegration | 获取Prometheus实例指定集成中心Exporter实例 | 获取Prometheus实例(仅支持aliyun-cs、ecs两种类型的实例)指定集成中心Exporter实例。 |
| ListPrometheusIntegration | 查询Prometheus实例集成中心Exporter实例列表 | 查询Prometheus实例(仅支持aliyun-cs、ecs两种类型的实例)集成中心Exporter实例列表。 |
| GetPrometheusInstance | 获取指定Prometheus实例信息 | 获取指定Prometheus实例信息。 |
| ListPrometheusInstanceByTagAndResourceGroupId | 根据标签和资源组查询Prometheus实例 | 根据标签和资源组查询Prometheus实例。 |
| CreatePrometheusInstance | 新建Prometheus实例 | 新建Prometheus实例。 |
| UpdatePrometheusInstance | 更新Prometheus实例信息 | 更新Prometheus实例信息。 |
| UpdatePrometheusGlobalView | 更新Prometheus for GlobalView聚合数据源 | 更新Prometheus for GlobalView聚合数据源。 |
| 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概述 |
|---|---|---|
| ApplyScenario | 创建或更新业务监控 | 创建或更新业务监控。 |
| DeleteScenario | 删除业务监控 | 删除业务监控。 |
| ListScenario | 获取业务监控详细信息 | 获取业务监控详细信息。 |
云拨测(新版)
| API | 标题 | API概述 |
|---|---|---|
| CreateTimingSyntheticTask | 创建定时拨测任务 | 创建定时拨测任务(新版)。 |
| UpdateTimingSyntheticTask | 更新定时拨测任务 | 更新定时拨测任务。 |
| StopTimingSyntheticTask | 停止定时拨测任务 | 停止定时拨测任务。 |
| StartTimingSyntheticTask | 启动定时拨测任务 | 启动定时拨测任务。 |
| DeleteTimingSyntheticTask | 删除定时拨测任务 | 删除定时拨测任务。 |
| GetSyntheticMonitors | 获取拨测点 | 获取拨测点。 |
| ListTimingSyntheticTasks | 获取定时拨测任务列表 | 获取定时拨测任务列表。 |
| GetTimingSyntheticTask | 获取拨测任务详情 | 获取任务详情。 |
| ListSyntheticDetail | 获取拨测结果 | 获取拨测结果。 |
云拨测(旧版)
| API | 标题 | API概述 |
|---|---|---|
| CreateSyntheticTask | 创建或更新云拨测任务 | 创建或更新云拨测定时任务。 |
| GetSyntheticTaskMonitors | 获取拨测点信息 | 获取拨测点信息。 |
| SwitchSyntheticTaskStatus | 启停拨测任务 | 启动或者停止定时拨测任务。 |
| GetSyntheticTaskList | 获取拨测任务列表 | 获取云拨测定时任务列表。 |
| GetSyntheticTaskDetail | 获取定时拨测任务的详情 | 根据任务ID获取定时拨测任务的详情。 |
| DeleteSyntheticTask | 删除拨测任务 | 删除云拨测定时任务。 |
告警管理(新版)
| API | 标题 | API概述 |
|---|---|---|
| CreateIntegration | 创建告警集成 | 创建告警集成。 |
| UpdateIntegration | 修改集成相关信息 | 修改集成相关信息。 |
| DeleteIntegrations | 删除指定告警集成 | 删除指定告警集成。 |
| ListIntegration | 查看集成列表详情 | 查看集成列表详情。 |
| CreateOrUpdateAlertRule | 创建或修改告警规则 | 创建或修改告警规则。 |
| DeleteAlertRule | 删除告警规则 | 删除告警规则。 |
| ListAlertEvents | 查询告警事件历史 | 查询告警事件历史。 |
| GetAlertRules | 获取已经创建的告警规则 | 查询已经创建的告警规则。 |
| CreateOrUpdateContact | 创建或修改联系人 | 创建或者修改告警联系人。 |
| SendTTSVerifyLink | 告警联系人发送手机号码验证 | 为告警联系人发送手机号码验证短信。 |
| DeleteContact | 删除告警联系人 | 删除告警联系人。 |
| DescribeContacts | 查询告警联系人列表 | 查询告警联系人列表。 |
| CreateOrUpdateContactGroup | 创建或修改告警联系人组 | 创建或修改告警联系人组。 |
| DeleteContactGroup | 删除告警联系人组 | 删除告警联系人组。 |
| DescribeContactGroups | 查询告警联系人分组信息 | 查询告警联系人分组信息。 |
| CreateOrUpdateIMRobot | 创建或更新IM机器人 | 创建或更新IM机器人。 |
| DeleteIMRobot | 删除IM机器人 | 删除IM机器人。 |
| DescribeIMRobots | 查询IM机器人列表 | 查询IM机器人列表。 |
| CreateOrUpdateWebhookContact | 创建或修改Webhook告警联系人 | 创建或修改Webhook告警联系人。 |
| DeleteWebhookContact | 删除Webhook告警联系人 | 删除Webhook告警联系人。 |
| DescribeWebhookContacts | 查询Webhook告警联系人列表 | 查询Webhook告警联系人列表。 |
| CreateOrUpdateEventBridgeIntegration | 创建或修改EventBridge通知集成 | 创建或修改EventBridge通知集成。 |
| DeleteEventBridgeIntegration | 删除EventBridge通知集成 | 删除EventBridge通知集成。 |
| ListEventBridgeIntegrations | 查询EventBridge通知集成信息 | 查询EventBridge通知集成信息。 |
| CreateOrUpdateNotificationPolicy | 新增及修改通知策略 | 创建或更新通知策略。 |
| DeleteNotificationPolicy | 删除通知策略 | 根据通知策略ID删除通知策略。 |
| ListNotificationPolicies | 查询通知策略信息 | 通过指定条件查询通知策略信息。 |
| CreateOrUpdateSilencePolicy | 新增及修改静默策略 | 创建或修改静默策略。 |
| DeleteSilencePolicy | 删除静默策略 | 调用DeleteSilencePolicy接口根据静默策略ID删除静默策略。 |
| ListEscalationPolicies | 查询升级策略信息 | 调用ListEscalationPolicies接口查询升级策略信息。 |
| ListOnCallSchedules | 查询排班策略 | 调用ListOnCallSchedules接口查询排班策略信息。 |
| GetOnCallSchedulesDetail | 查询排班策略信息 | 调用GetOnCallSchedulesDetail接口查询排班策略信息。 |
| ListSilencePolicies | 静默策略列表信息 | 调用ListSilencePolicies接口查询静默策略列表信息。 |
| ListAlerts | 查询告警发送历史 | 告警发送历史接口。 |
| BlockAlarmNotification | 屏蔽告警通知 | 屏蔽告警通知,屏蔽后告警在指定的时间范围内不再发生通知。 |
| ChangeAlarmSeverity | 修改告警等级 | 修改告警等级。 |
| CloseAlarm | 关闭告警 | 关闭告警,请确保告警恢复后再关闭告警。如果告警一直处于触发状态,关闭告警后又会产生新的告警。 |
| ClaimAlarm | 认领告警 | 认领告警,配合升级策略使用。 在告警协同处理时可以,认领后表示该告警正在处理中。 |
Prometheus报警规则(旧版)
| API | 标题 | API概述 |
|---|---|---|
| CreatePrometheusAlertRule | 创建告警规则 | 创建告警规则。 |
| DeletePrometheusAlertRule | 删除告警规则 | 删除Prometheus告警规则。 |
| UpdatePrometheusAlertRule | 更新告警规则 | 调用UpdatePrometheusAlertRule接口更新Prometheus报警规则。 |
| DescribePrometheusAlertRule | 查看告警规则 | 查看Prometheus告警规则。 |
| ListPrometheusAlertRules | 查看告警规则列表 | 查看Prometheus告警规则列表。 |
| ListPrometheusAlertTemplates | 查看告警模板列表 | 调用ListPrometheusAlertTemplates接口查看Prometheus告警模板列表。 |
报警(旧版)
| API | 标题 | API概述 |
|---|---|---|
| CreateAlertContact | 创建报警联系人 | 创建报警联系人。 |
| CreateWebhook | 创建Webhook告警联系人 | 调用CreateWebhook接口创建Webhook告警联系人。 |
| CreateAlertContactGroup | 创建报警联系人分组 | 调用CreateAlertContactGroup接口创建报警联系人分组。 |
| CreateDispatchRule | 创建分派策略 | 创建分派策略。 |
| ListActivatedAlerts | 查询已经触发的告警列表 | 调用ListActivatedAlerts接口查询已经触发的告警列表。 |
| ImportAppAlertRules | 创建应用报警规则 | 调用ImportAppAlertRules接口创建应用报警规则。 |
| DeleteAlertRules | 删除报警规则 | 调用DeleteAlertRules接口删除报警规则。 |
| DeleteAlertContact | 删除报警联系人 | 调用DeleteAlertContact接口删除报警联系人。 |
| DeleteAlertContactGroup | 删除报警联系人分组 | 调用DeleteAlertContactGroup接口删除报警联系人分组。 |
| DeleteDispatchRule | 删除指定ID的通知策略 | 加快删除指定ID的告警通知策略。 |
| UpdateWebhook | 更新Webhook联系人 | 调用UpdateWebhook接口修改Webhook告警联系人信息。 |
| UpdateAlertContact | 更新报警联系人 | 调用UpdateAlertContact接口更新报警联系人。 |
| UpdateAlertContactGroup | 更新报警联系人分组 | 调用UpdateAlertContactGroup接口更新报警联系人分组。 |
| UpdateAlertRule | 更新监控告警规则 | 调用UpdateAlertRule接口更新报警规则。 |
| StartAlert | 启动报警规则 | 调用StartAlert接口启动报警规则。 |
| StopAlert | 停止报警规则 | 调用StartAlert接口停止报警规则。 |
| UpdateDispatchRule | 修改分派策略 | 调用UpdateDispatchRule接口修改分派策略。 |
| SearchAlertRules | 查询报警规则 | 调用SearchAlertRules接口查询报警规则。 |
| SearchAlertContact | 查询报警联系人 | 调用SearchAlertContact接口查询报警联系人。 |
| SearchAlertContactGroup | 查询报警联系人分组 | 调用SearchAlertContactGroup接口查询报警联系人分组。 |
| SearchAlertHistories | 查询报警规则的报警发送记录 | 调用SearchAlertHistories接口查询报警规则的报警发送记录。 |
| SearchEvents | 查询报警事件记录 | 调用SearchEvents接口查询报警事件记录。 |
| DescribeDispatchRule | 查询分派策略信息 | 调用DescribeDispatchRule接口查询分派策略信息。 |
| ListDispatchRule | 获取调度规则列表 | 调用ListDispatchRule接口查询通知策略列表。 |
访问控制
| 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、用户体验监控四大产品用量数据。 |