API概览

本产品(应用实时监控服务ARMS/2019-08-08)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

服务开通

API标题API概述
OpenArmsServiceSecondVersion开通ARMS调用OpenArmsServiceSecondVersion接口开通ARMS下指定子产品的后付费功能。
OpenXtraceDefaultSLR开通链路追踪服务关联角色调用OpenXtraceDefaultSLR接口开通链路追踪服务关联角色AliyunServiceRoleForXtrace。
OpenArmsDefaultSLR开通ARMS服务关联角色调用OpenArmsDefaultSLR接口开通ARMS服务关联角色AliyunServiceRoleForARMS。

监控指标

API标题API概述
QueryMetricByPage查询监控指标调用QueryMetricByPage接口分页查询应用监控或前端监控的相关监控指标。

应用监控

API标题API概述
TurnOnSecondSwitch打开秒级开关发布前调用TurnOnSecondSwitch接口使数据统计的Interval从60s变为5s。
GetTraceApp获取应用监控任务详情调用GetTraceApp接口获取应用监控任务详情。
GetAppApiByPage查询应用监控的API数据调用GetAppApiByPage接口按分页查询应用监控的API数据。
GetTrace获取调用链详情调用GetTrace加快获取调用链详情。
GetStack获取调用链方法栈调用GetStack接口获取调用链方法栈信息。
GetMultipleTrace获取多个调用链详情调用GetMultipleTrace接口获取多个调用链的详情。
ConfigApp打开或关闭应用监控总开关调用ConfigApp接口打开或关闭应用监控的Agent总开关,或者查询Agent总开关的状态。
SaveTraceAppConfig应用监控自定义设置调用SaveTraceAppConfig接口进行应用监控的自定义设置(如调用链采样设置、Agent开关等)。
DeleteIntegration删除Integration接入的采集规则调用DeleteIntegration接口来删除Integration接入的采集规则。
DeleteTraceApp删除指定ID和类型的应用调用DeleteTraceApp接口删除指定ID和类型的应用。
GetIntegrationState获取Integration的接入状态调用GetIntegrationState接口来获取Integration的接入状态。
QueryReleaseMetric查看不同版本的指标查询EDAS和K8s应用发布过程中不同版本的指标。
ListTraceApps获取指定地域下全部应用监控任务的列表调用ListTraceApps接口获取指定地域下全部应用监控任务的列表。
SearchTraceAppByName按应用名称查询应用监控任务来按应用名称查询应用监控任务。
SearchTraceAppByPage分页查询应用监控任务来分页查询应用监控任务。
SearchTraces查询调用链列表信息调用SearchTraces接口查询调用链列表信息,可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。
SearchTracesByPage分页查询调用链列表信息调用SearchTracesByPage接口分页查询调用链列表信息,可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。
GetAgentDownloadUrl获取探针下载链接调用GetAgentDownloadUrl接口获取探针下载链接。
DescribeTraceLicenseKey列出LicenseKey调用DescribeTraceLicenseKey接口列出LicenseKey。
ListInsightsEvents查询异常事件列表调用ListInsightsEvents接口查询指定时间段内Insights的异常事件列表。

前端监控

API标题API概述
Upload上传SourceMap调用Upload接口上传SourceMap到ARMS前端监控。
DeleteSourceMap删除SourceMap文件调用DeleteSourceMap接口删除前端监控中上传的SourceMap文件。
GetSourceMapInfo获取SourceMap文件详细信息调用GetSourceMapInfo接口获取前端监控中上传的SourceMap文件详细信息。
CreateRetcodeApp创建前端监控任务调用CreateRetcodeApp接口创建前端监控任务。
GetRetcodeShareUrl获取前端监控站点的分享地址调用GetRetcodeShareUrl接口获取前端监控站点的分享地址。
DeleteRetcodeApp删除前端监控任务调用DeleteRetcodeApp接口删除前端监控任务。
SetRetcodeShareStatus打开或关闭前端监控站点的免登录分享开关调用SetRetcodeShareStatus接口打开或关闭前端监控站点的免登录分享开关。
ListRetcodeApps列出所有前端监控任务调用ListRetcodeApps接口列出指定地域下所有前端监控任务。
SearchRetcodeAppByPage分页查询前端监控任务调用SearchRetcodeAppByPage分页查询前端监控任务。
GetRetcodeLogstore获取Project和Logstore获取指定账号下前端监控应用对应SLS存储的Project和Logstore。

业务监控

API标题API概述
ApplyScenario创建或更新业务监控调用ApplyScenario接口创建或更新业务监控。
ListScenario获取业务监控详细信息调用ListScenario接口获取业务监控详细信息。

云拨测

API标题API概述
CreateSyntheticTask创建或更新云拨测任务调用CreateSyntheticTask接口创建或更新云拨测定时任务。
GetSyntheticTaskMonitors获取拨测点信息调用GetSyntheticTaskMonitors接口获取拨测点信息。
SwitchSyntheticTaskStatus启停拨测任务启动或者停止定时拨测任务。
GetSyntheticTaskList获取拨测任务列表获取云拨测定时任务列表。
GetSyntheticTaskDetail获取定时拨测任务的详情根据任务ID获取定时拨测任务的详情。
DeleteSyntheticTask删除拨测任务调用DeleteSyntheticTask接口删除云拨测定时任务。

Prometheus监控

API标题API概述
AppendInstancesToPrometheusGlobalView新增Prometheus实例数据源调用AppendInstancesToPrometheusGlobalView接口增加ARMS Prometheus监控聚合实例中的数据源,将数据源添加到Prometheus聚合实例。
AddPrometheusInstance创建RemoteWrite类型的Prometheus实例创建RemoteWrite类型Prometheus实例。 。
AddPrometheusGlobalViewByAliClusterIds新增容器聚合实例调用AddPrometheusGlobalViewByAliClusterIds接口增加ARMS Prometheus监控的聚合实例。
AddPrometheusGlobalView新增聚合实例调用AddPrometheusGlobalView接口增加ARMS Prometheus监控的聚合实例。
AddAliClusterIdsToPrometheusGlobalView新增聚合实例数据源调用AddAliClusterIdsToPrometheusGlobalView接口增加ARMS Prometheus监控聚合实例的数据源。
AddRecordingRule创建RecordingRule调用AddRecordingRule接口创建或者更新Prometheus监控的RecordingRule规则。
SyncRecordingRules将某个集群的聚合规则批量同步到全Region的其他目标集群将某个集群的聚合规则批量同步到全Region的其他目标集群。
AddIntegration集成大盘及采集规则调用AddIntegration接口集成ARMS Prometheus监控的大盘以及采集规则。
AddGrafana集成Prometheus监控大盘调用AddGrafana接口集成ARMS Prometheus监控的大盘。
InstallCmsExporter安装云服务采集器调用InstallCmsExporter接口安装云服务采集器。
InstallManagedPrometheus创建托管Prometheus调用InstallManagedPrometheus接口创建托管(ASK/ECS)Prometheus。
GetManagedPrometheusStatus获取托管版Prometheus安装状态获取托管版(ask/ecs)Prometheus实例的安装状态。
OpenVCluster开通虚拟集群调用OpenVCluster接口开通虚拟集群。
DeletePrometheusGlobalView删除Prometheus聚合实例调用DeletePrometheusGlobalView接口删除Prometheus聚合实例。
RemoveAliClusterIdsFromPrometheusGlobalView删除聚合实例数据源调用RemoveAliClusterIdsFromPrometheusGlobalView接口移除ARMS Prometheus监控聚合实例的某些数据源。
RemoveSourcesFromPrometheusGlobalView删除聚合实例非阿里数据源调用RemoveSourcesFromPrometheusGlobalView接口移除ARMS Prometheus监控聚合实例中的数据源,仅支持删除非阿里数据源。
DeleteCmsExporter卸载Prometheus for 云服务实例调用DeleteCmsExporter接口来卸载Prometheus for 云服务实例。
DelAuthToken关闭鉴权token调用DelAuthToken接口关闭鉴权token。
DeleteGrafanaResource删除集群的大盘资源调用DeleteGrafanaResource接口删除ARMS Prometheus监控集群中的Grafana大盘资源。
UninstallManagedPrometheus卸载托管Prometheus调用UninstallManagedPrometheus接口卸载托管(ASK/ECS)Prometheus。
UninstallPromCluster卸载集群调用UninstallPromCluster接口来卸载ARMS Prometheus集群。
ManageRecordingRule修改聚合规则调用ManageRecordingRule接口编辑ARMS Prometheus的RecordingRule聚合规则。
QueryPromInstallStatus查询集群安装状态调用QueryPromInstallStatus接口来查询ARMS Prometheus集群的安装状态。
ListPrometheusGlobalView获取聚合实例列表调用ListPrometheusGlobalView接口增加ARMS Prometheus监控的聚合实例,获取聚合实例列表。
GetPrometheusGlobalView获取聚合实例的数据源详情调用GetPrometheusGlobalView接口增加ARMS Prometheus监控的聚合实例,获取指定聚合实例的详细数据源情况。
ManageGetRecordingRule获取聚合规则调用ManageGetRecordingRule接口获取ARMS Prometheus的RecordingRule聚合规则。
CheckServiceStatus检查产品开通状态检查集群当前的服务状态,例如是否开通服务,是否欠费等。
GetPrometheusApiToken获取Prometheus监控所需Token调用GetPrometheusApiToken接口获取集成ARMS Prometheus监控所需的Token。
ListDashboards获取集群的大盘列表调用ListDashboards接口获取集群的Grafana大盘的列表。
ListClusterFromGrafana列出指定地域下的所有Grafana大盘列出指定地域下的所有Grafana大盘。
GetExploreUrl获取Grafana的Explore功能获取使用Grafana的Explore功能。
GetRecordingRule获取聚合规则获取集群的RecordingRule聚合规则。
ListCmsInstances查询云服务采集状态调用ListCmsInstances接口查询云服务采集状态。
ListDashboardsByName创建Loki数据源和相关的多数据源大盘调用ListDashboardsByName接口来创建与Prometheus关联的Loki数据源和相关的多数据源大盘。
GetAuthToken获取公网读写鉴权调用GetAuthToken接口获取公网读写鉴权Token。
GetClusterAllUrl获取集群所有地址获取集群所有地址。包括远程读写地址、 Push Gateway地址、 Grafana地址。 。
ListPrometheusInstances获取所有正常实例调用ListPrometheusInstances接口获取Prometheus的所有正常实例。

Prometheus报警规则(旧版)

API标题API概述
CreatePrometheusAlertRule创建告警规则创建告警规则。
UpdatePrometheusAlertRule 更新告警规则更新告警规则。
DescribePrometheusAlertRule查看告警规则查看Prometheus告警规则。
ListPrometheusAlertRules查看告警规则列表查看Prometheus告警规则列表。

报警(旧版)

API标题API概述
CreateWebhook创建Webhook告警联系人调用CreateWebhook接口创建Webhook告警联系人。
CreateDispatchRule创建分派策略调用CreateDispatchRule接口创建分派策略。
ListActivatedAlerts查询已经触发的告警列表调用ListActivatedAlerts接口查询已经触发的告警列表。
ImportAppAlertRules创建应用报警规则调用ImportAppAlertRules接口创建应用报警规则。
DeleteAlertRules删除报警规则调用DeleteAlertRules接口删除报警规则。
UpdateWebhook更新触发器调用UpdateWebhook接口修改Webhook告警联系人信息。
UpdateAlertContactGroup更新报警联系人分组调用UpdateAlertContactGroup接口更新报警联系人分组。
UpdateAlertRule更新监控告警规则调用UpdateAlertRule接口更新报警规则。
UpdateDispatchRule修改分派策略调用UpdateDispatchRule接口修改分派策略。
SearchAlertRules查询报警规则调用SearchAlertRules接口查询报警规则。
SearchAlertContact查询报警联系人调用SearchAlertContact接口查询报警联系人。
SearchAlertContactGroup查询报警联系人分组调用SearchAlertContactGroup接口查询报警联系人分组。
SearchAlertHistories查询报警规则的报警发送记录调用SearchAlertHistories接口查询报警规则的报警发送记录。
SearchEvents查询报警事件记录调用SearchEvents接口查询报警事件记录。
DescribeDispatchRule查询分派策略信息调用DescribeDispatchRule接口查询分派策略信息。
ListPrometheusAlertTemplates查看告警模板列表调用ListPrometheusAlertTemplates接口查看Prometheus告警模板列表。

告警管理(新版)

API标题API概述
CreateOrUpdateAlertRule创建或修改告警规则调用CreateOrUpdateAlertRule接口创建或修改告警规则。
CreateOrUpdateContact创建或修改联系人调用CreateOrUpdateContact接口创建或者修改告警联系人。
CreateOrUpdateWebhookContact创建或修改Webhook告警联系人调用CreateOrUpdateWebhookContact接口创建或修改Webhook告警联系人。
CreateOrUpdateContactGroup创建或修改告警联系人组调用CreateOrUpdateContactGroup接口创建或修改告警联系人组。
CreateOrUpdateIMRobot创建或更新IM机器人调用CreateOrUpdateIMRobot接口创建或更新IM机器人。
CreateOrUpdateNotificationPolicy新增及修改通知策略调用CreateOrUpdateNotificationPolicy接口创建或更新通知策略。
CreateOrUpdateSilencePolicy新增及修改静默策略调用CreateOrUpdateSilencePolicy接口创建或修改静默策略。
CreateOrUpdateEventBridgeIntegration创建或修改EventBridge通知集成调用CreateOrUpdateEventBridgeIntegration接口创建或修改EventBridge通知集成。
CreateIntegration创建告警集成调用CreateIntegration接口创建告警集成。
DeleteAlertRule删除告警规则调用DeleteAlertRule接口删除告警规则。
DeleteContact删除告警联系人调用DeleteContact接口删除告警联系人。
DeleteWebhookContact删除Webhook告警联系人调用DeleteWebhookContact接口删除Webhook告警联系人。
DeleteContactGroup告警联系人组调用DeleteContactGroup接口删除告警联系人组。
DeleteIMRobot删除IM机器人调用DeleteIMRobot接口删除IM机器人。
DeleteNotificationPolicy删除通知策略调用DeleteNotificationPolicy接口根据通知策略ID删除通知策略。
DeleteSilencePolicy删除静默策略调用DeleteSilencePolicy接口根据静默策略ID删除静默策略。
DeleteEventBridgeIntegration删除EventBridge通知集成调用DeleteEventBridgeIntegration接口删除EventBridge通知集成。
DeleteIntegrations删除指定告警集成调用DeleteIntegrations接口删除指定告警集成。
UpdateIntegration修改集成相关信息调用UpdateIntegration接口修改集成相关信息。
GetAlertRules获取已经创建的告警规则调用GetAlertRules接口查询已经创建的告警规则。
ListAlerts查询告警发送历史调用ListAlerts接口查询告警发送历史。
DescribeContacts查询告警联系人列表调用DescribeContacts接口查询告警联系人列表。
SendTTSVerifyLink告警联系人发送手机号码验证调用SendTTSVerifyLink接口为告警联系人发送手机号码验证短信。
DescribeWebhookContacts查询Webhook告警联系人列表调用DescribeWebhookContacts接口查询Webhook告警联系人列表。
DescribeContactGroups查询告警联系人分组信息调用DescribeContactGroups接口查询告警联系人分组信息。
DescribeIMRobots查询IM机器人列表调用DescribeIMRobots接口查询IM机器人列表。
ListNotificationPolicies查询通知策略信息调用ListNotificationPolicies接口通过指定条件查询通知策略信息。
ListSilencePolicies静默策略列表信息调用ListSilencePolicies接口查询静默策略列表信息。
ListEscalationPolicies查询升级策略信息调用ListEscalationPolicies接口查询升级策略信息。
ListOnCallSchedules查询排班策略调用ListOnCallSchedules接口查询排班策略信息。
GetOnCallSchedulesDetail查询排班策略信息调用GetOnCallSchedulesDetail接口查询排班策略信息。
ListEventBridgeIntegrations查询EventBridge通知集成信息调用ListEventBridgeIntegrations接口查询EventBridge通知集成信息。
ListIntegration查看集成列表详情调用ListIntegration接口查看集成列表详情。
ListAlertEvents查询告警事件历史查询告警事件历史。
阿里云首页 应用实时监控服务ARMS 相关技术圈