阿里云OpenAPI开发者门户

应用实时监控服务ARMS - OpenAPI 概览2019-08-08
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
监控指标
OpenAPI 名称描述操作
QueryMetricByPagehot分页查询应用监控或前端监控的相关监控指标查看文档去调试
应用监控
OpenAPI 名称描述操作
GetTraceApphot获取应用监控任务详情查看文档去调试
GetAppJVMConfig获取应用各个实例的JVM配置信息查看文档去调试
QueryAppTopology查询应用拓扑查看文档去调试
GetAppApiByPagehot通过分页的形式查询应用下每个接口的请求量、错误数、平均响应时间三种性能数据。可通过返回信息中的Completed字段判断分页是否结束。如未结束,CurrentPage参数加一后继续发起查询即可查看文档去调试
GetTracehot加快获取调用链详情查看文档去调试
GetStack获取调用链方法栈信息查看文档去调试
GetMultipleTrace获取多个调用链的详情查看文档去调试
GetTraceAppConfig查询应用监控中,某个应用的全部自定义设置(如调用链采样设置、Agent开关等)。此接口仅适用于接入应用监控的应用,不适用于接入可观测链路 OpenTelemetry 版的应用查看文档去调试
QueryReleaseMetric查询EDAS和K8s应用发布过程中不同版本的指标查看文档去调试
ListTraceAppshot获取指定地域下全部应用监控任务的列表查看文档去调试
SearchTraceAppByName按应用名称查询应用监控任务查看文档去调试
SearchTraceAppByPage分页查询应用监控任务查看文档去调试
SearchTraces查询调用链列表信息,可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链查看文档去调试
SearchTracesByPage分页查询调用链列表信息,可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链查看文档去调试
GetAgentDownloadUrl获取探针下载链接查看文档去调试
DescribeTraceLicenseKey列出LicenseKey查看文档去调试
ListInsightsEvents查询指定时间段内Insights的异常事件列表查看文档去调试
QueryAppMetadata根据ID和类型查询编码映射内容查看文档去调试
DoInsightsAction根据参数指定的模块类型,执行相应的动作查看文档去调试
ConfigApp打开或关闭应用监控的Agent总开关,或者查询Agent总开关的状态查看文档去调试
SaveTraceAppConfig进行应用监控的自定义设置(如调用链采样设置、Agent开关等)查看文档去调试
DeleteTraceApp删除指定ID或类型的应用查看文档去调试
DeleteAppList根据应用监控PID列表,批量删除应用查看文档去调试
GetAgentDownloadUrlV2获取探针下载地址查看文档去调试
前端监控
OpenAPI 名称描述操作
CreateRetcodeApp创建前端监控任务查看文档去调试
GetSourceMapInfo获取前端监控中上传的SourceMap文件详细信息查看文档去调试
GetRetcodeShareUrl获取前端监控站点的分享地址查看文档去调试
ListRetcodeApps列出指定地域下所有前端监控任务查看文档去调试
SearchRetcodeAppByPage分页查询前端监控任务查看文档去调试
GetRetcodeLogstore获取指定账号下前端监控应用对应SLS存储的Project和Logstore查看文档去调试
GetRetcodeDataByQuery根据SLS的查询语句查询前端监控的数据查看文档去调试
GetRetcodeAppByPid根据前端监控应用Pid返回前端监控应用对象查看文档去调试
SetRetcodeShareStatus打开或关闭前端监控站点的免登录分享开关,打开该功能后即可通过调用GetRetcodeShareUrl接口获取的地址访问前端监控页面查看文档去调试
DeleteSourceMap删除前端监控中上传的SourceMap文件查看文档去调试
DeleteRetcodeApp删除前端监控任务查看文档去调试
Upload上传SourceMap到ARMS前端监控查看文档去调试
用户体验监控
OpenAPI 名称描述操作
CreateRumUploadFileUrl用于上传SourceMap文件、符号表文件等查看文档去调试
CreateRumApp创建RUM应用查看文档去调试
GetRumUploadFiles获取RUM相关文件,包括符号表、SourceMap等查看文档去调试
GetRumDataForPage分页获取RUM数据查看文档去调试
GetRumAppInfo获取前端监控单个应用信息查看文档去调试
GetRumApps获取RUM应用列表查看文档去调试
GetRumExceptionStack获取RUM异常堆栈信息查看文档去调试
UpdateRumFileStatus更新RUM文件状态,上传RUM文件成功后,调用此接口查看文档去调试
UpdateRumApp更新RUM应用查看文档去调试
DeleteRumUploadFile用于删除符号表、SourceMap等文件查看文档去调试
DeleteRumApp删除RUM应用查看文档去调试
可观测监控 Prometheus 版
OpenAPI 名称描述操作
CreateEnvironment创建环境实例查看文档去调试
InstallEnvironmentFeature安装Feature查看文档去调试
CreateEnvCustomJob创建环境的自定义Job查看文档去调试
CreateEnvPodMonitor创建环境的PodMonitor查看文档去调试
CreateEnvServiceMonitor创建环境的ServiceMonitor查看文档去调试
InstallAddon安装Addon信息查看文档去调试
EnableMetric启用废弃指标查看文档去调试
CreatePrometheusMonitoring创建Prometheus实例的监控配置查看文档去调试
deprecatedAddPrometheusInstance创建RemoteWrite类型Prometheus实例查看文档去调试
AddPrometheusGlobalViewByAliClusterIds增加ARMS Prometheus监控的聚合实例查看文档去调试
AddPrometheusGlobalView增加ARMS Prometheus监控的聚合实例查看文档去调试
AddAliClusterIdsToPrometheusGlobalView增加ARMS Prometheus监控聚合实例的数据源查看文档去调试
AddRecordingRule创建或者更新Prometheus监控的RecordingRule规则查看文档去调试
deprecatedAddIntegration集成ARMS Prometheus监控的大盘以及采集规则查看文档去调试
AddGrafana集成ARMS Prometheus监控的大盘查看文档去调试
deprecatedInstallCmsExporter安装云服务采集器查看文档去调试
OpenVCluster开通虚拟集群查看文档去调试
deprecatedInstallManagedPrometheus创建托管(ASK/ECS)Prometheus查看文档去调试
deprecatedAddPrometheusIntegration增加Prometheus实例的集成中心Exporter实例(仅支持aliyun-cs、ecs两种类型的实例)查看文档去调试
CreatePrometheusInstance新建Prometheus实例查看文档去调试
DescribeEnvironment查询环境详情查看文档去调试
ListEnvironments查询环境列表查看文档去调试
DescribeAddonMetrics查询指定Addon的指标详情查看文档去调试
DescribeEnvironmentFeature查询Feature详情查看文档去调试
ListEnvironmentFeatures查询环境中的Feature查看文档去调试
ListEnvCustomJobs查询环境的自定义Job列表查看文档去调试
DescribeEnvCustomJob查询环境CustomJob详情查看文档去调试
DescribeEnvPodMonitor查询环境的PodMonitor详情查看文档去调试
ListEnvPodMonitors查询环境的PodMonitor列表查看文档去调试
DescribeEnvServiceMonitor查询环境的ServiceMonitor详情查看文档去调试
ListEnvServiceMonitors查询环境的ServiceMonitor列表查看文档去调试
DescribeAddonRelease通过名称查询AddonRelease详情查看文档去调试
ListAddons新版接入中心产品列表查看文档去调试
ListAddonReleases查询环境中安装的Addon查看文档去调试
ListEnvironmentDashboards查询环境中的大盘信息查看文档去调试
ListPrometheusMonitoring查询Prometheus实例监控配置查看文档去调试
GetPrometheusMonitoring查询Prometheus实例指定监控配置查看文档去调试
deprecatedGetIntegrationState来获取Integration的接入状态查看文档去调试
QueryPromInstallStatus来查询ARMS Prometheus集群的安装状态查看文档去调试
ListPrometheusGlobalView增加ARMS Prometheus监控的聚合实例,获取聚合实例列表查看文档去调试
GetPrometheusGlobalView增加ARMS Prometheus监控的聚合实例,获取指定聚合实例的详细数据源情况查看文档去调试
CheckServiceStatus检查集群当前的服务状态,例如是否开通服务,是否欠费等查看文档去调试
GetPrometheusApiToken获取集成ARMS Prometheus监控所需的Token查看文档去调试
GetExploreUrl获取使用Grafana的Explore功能查看文档去调试
ListDashboards获取集群的Grafana大盘的列表查看文档去调试
ListClusterFromGrafana列出指定地域下的所有Grafana大盘查看文档去调试
GetRecordingRule获取集群的RecordingRule聚合规则查看文档去调试
deprecatedListCmsInstances查询云服务采集状态查看文档去调试
ListDashboardsByName来创建与Prometheus关联的Loki数据源和相关的多数据源大盘查看文档去调试
GetAuthToken获取公网读写鉴权Token查看文档去调试
deprecatedGetClusterAllUrl获取集群所有地址。包括远程读写地址、 Push Gateway地址、 Grafana地址查看文档去调试
deprecatedGetCloudClusterAllUrl获取云监控云产品读写地址,pushgateway,grafana 地址查看文档去调试
ListPrometheusInstances获取Prometheus的所有正常实例查看文档去调试
deprecatedGetManagedPrometheusStatus获取托管版(ask、ecs和one)Prometheus实例的安装状态查看文档去调试
deprecatedGetPrometheusIntegration获取Prometheus实例(仅支持aliyun-cs、ecs两种类型的实例)指定集成中心Exporter实例查看文档去调试
deprecatedListPrometheusIntegration查询Prometheus实例(仅支持aliyun-cs、ecs两种类型的实例)集成中心Exporter实例列表查看文档去调试
GetPrometheusInstance获取指定Prometheus实例信息查看文档去调试
ListPrometheusInstanceByTagAndResourceGroupId根据标签和资源组查询Prometheus实例查看文档去调试
InitEnvironment初始化环境实例查看文档去调试
UpdateEnvironment更新环境信息查看文档去调试
UpgradeEnvironmentFeature更新Feature信息查看文档去调试
RestartEnvironmentFeature重启feature查看文档去调试
UpdateEnvCustomJob更新环境的自定义Job查看文档去调试
UpdateEnvPodMonitor更新环境的PodMonitor查看文档去调试
UpdateEnvServiceMonitor更新环境的ServiceMonitor查看文档去调试
UpgradeAddonRelease更新AddonRelease信息查看文档去调试
UpdateMetricDrop更新废弃指标列表查看文档去调试
UpdatePrometheusMonitoringStatus更新Prometheus实例监控配置状态查看文档去调试
UpdatePrometheusMonitoring更新Prometheus实例监控配置查看文档去调试
AppendInstancesToPrometheusGlobalView增加ARMS Prometheus监控聚合实例中的数据源,将数据源添加到Prometheus聚合实例查看文档去调试
SyncRecordingRules将某个集群的聚合规则批量同步到全Region的其他目标集群查看文档去调试
DelAuthToken关闭鉴权token查看文档去调试
BindPrometheusGrafanaInstance绑定Prometheus实例使用的Grafana工作区ID查看文档去调试
deprecatedUpdatePrometheusIntegration更改Prometheus实例(仅支持aliyun-cs、ecs两种类型的实例)集成中心Exporter配置查看文档去调试
UpdatePrometheusInstance更新Prometheus实例信息查看文档去调试
UpdatePrometheusGlobalView更新Prometheus for GlobalView聚合数据源查看文档去调试
DeleteEnvironment删除环境实例查看文档去调试
DeleteEnvironmentFeature删除feature查看文档去调试
DeleteEnvCustomJob删除环境的自定义job查看文档去调试
DeleteEnvPodMonitor删除环境PodMonitor查看文档去调试
DeleteEnvServiceMonitor删除环境ServiceMonitor查看文档去调试
DeleteAddonRelease通过AddonRelease名称删除AddonRelease数据查看文档去调试
DeletePrometheusMonitoring删除Prometheus实例监控配置查看文档去调试
deprecatedDeleteIntegration删除Integration接入的采集规则查看文档去调试
DeletePrometheusGlobalView删除Prometheus聚合实例查看文档去调试
RemoveAliClusterIdsFromPrometheusGlobalView移除ARMS Prometheus监控聚合实例的某些数据源查看文档去调试
RemoveSourcesFromPrometheusGlobalView移除ARMS Prometheus监控聚合实例中的数据源,仅支持删除非阿里数据源查看文档去调试
deprecatedDeleteCmsExporter来卸载Prometheus for 云服务实例查看文档去调试
DeleteGrafanaResource删除ARMS Prometheus监控集群中的Grafana大盘资源查看文档去调试
UninstallPromCluster来卸载ARMS Prometheus集群实例查看文档去调试
deprecatedUninstallManagedPrometheus卸载托管(ASK/ECS/ACKoNE)Prometheus查看文档去调试
deprecatedDeletePrometheusIntegration删除Prometheus实例集成中心Exporter实例(仅支持aliyun-cs、ecs两种类型的实例)查看文档去调试
AddTagToFlinkCluster主要将用户Flink工作空间对应的Prometheus实例打上工作空间ID、工作空间名称这两个Tag查看文档去调试
可观测可视化 Grafana 版
OpenAPI 名称描述操作
CreateGrafanaWorkspace创建可观测可视化 Grafana 版工作区实例查看文档去调试
ListGrafanaWorkspace获取地域内Grafana工作区列表查看文档去调试
GetGrafanaWorkspace查询指定Grafana工作区信息查看文档去调试
UpdateGrafanaWorkspace更新指定Grafana工作区信息查看文档去调试
UpdateGrafanaWorkspaceVersion更新Grafana工作区版本查看文档去调试
DeleteGrafanaWorkspace删除可观测可视化 Grafana 版工作区实例查看文档去调试
业务监控
OpenAPI 名称描述操作
ListScenario获取业务监控详细信息查看文档去调试
DeleteScenario删除业务监控查看文档去调试
ApplyScenario创建或更新业务监控查看文档去调试
云拨测(新版)
OpenAPI 名称描述操作
CreateTimingSyntheticTask创建定时拨测任务(新版)查看文档去调试
GetSyntheticMonitors获取拨测点查看文档去调试
GetTimingSyntheticTask获取任务详情查看文档去调试
ListSyntheticDetail获取拨测结果查看文档去调试
UpdateTimingSyntheticTask更新定时拨测任务查看文档去调试
StopTimingSyntheticTask停止定时拨测任务查看文档去调试
StartTimingSyntheticTask启动定时拨测任务查看文档去调试
DeleteTimingSyntheticTask删除定时拨测任务查看文档去调试
ListTimingSyntheticTasks获取定时拨测任务列表查看文档去调试
云拨测(旧版)
OpenAPI 名称描述操作
CreateSyntheticTask创建或更新云拨测定时任务查看文档去调试
GetSyntheticTaskMonitors获取拨测点信息查看文档去调试
GetSyntheticTaskList获取云拨测定时任务列表查看文档去调试
GetSyntheticTaskDetail根据任务ID获取定时拨测任务的详情查看文档去调试
SwitchSyntheticTaskStatus启动或者停止定时拨测任务查看文档去调试
DeleteSyntheticTask删除云拨测定时任务查看文档去调试
告警管理(新版)
OpenAPI 名称描述操作
CreateIntegration创建告警集成查看文档去调试
CreateOrUpdateAlertRulehot创建或修改告警规则查看文档去调试
CreateOrUpdateContact创建或者修改告警联系人查看文档去调试
CreateOrUpdateContactGroup创建或修改告警联系人组查看文档去调试
CreateOrUpdateIMRobot创建或更新IM机器人查看文档去调试
CreateOrUpdateWebhookContact创建或修改Webhook告警联系人查看文档去调试
CreateOrUpdateEventBridgeIntegration创建或修改EventBridge通知集成查看文档去调试
CreateOrUpdateNotificationPolicy创建或更新通知策略查看文档去调试
CreateOrUpdateSilencePolicy创建或修改静默策略查看文档去调试
ListIntegration查看集成列表详情查看文档去调试
ListAlertEventshot查询告警事件历史查看文档去调试
GetAlertRuleshot查询已经创建的告警规则查看文档去调试
DescribeContacts查询告警联系人列表查看文档去调试
DescribeContactGroups查询告警联系人分组信息查看文档去调试
DescribeIMRobots查询IM机器人列表查看文档去调试
DescribeWebhookContacts查询Webhook告警联系人列表查看文档去调试
ListEventBridgeIntegrations查询EventBridge通知集成信息查看文档去调试
ListNotificationPolicies通过指定条件查询通知策略信息查看文档去调试
ListEscalationPolicies查询升级策略信息查看文档去调试
ListOnCallSchedules查询排班策略信息查看文档去调试
GetOnCallSchedulesDetail查询排班策略信息查看文档去调试
ListSilencePolicies查询静默策略列表信息查看文档去调试
ListAlertshot告警发送历史接口查看文档去调试
UpdateIntegration修改集成相关信息查看文档去调试
BlockAlarmNotification屏蔽告警通知,屏蔽后告警在指定的时间范围内不再发生通知查看文档去调试
ChangeAlarmSeverity修改告警等级查看文档去调试
CloseAlarm关闭告警,请确保告警恢复后再关闭告警。如果告警一直处于触发状态,关闭告警后又会产生新的告警查看文档去调试
ClaimAlarm认领告警,配合升级策略使用。 在告警协同处理时可以,认领后表示该告警正在处理中查看文档去调试
DeleteIntegrations删除指定告警集成查看文档去调试
DeleteAlertRule删除告警规则查看文档去调试
DeleteContact删除告警联系人查看文档去调试
DeleteContactGroup删除告警联系人组查看文档去调试
DeleteIMRobot删除IM机器人查看文档去调试
DeleteWebhookContact删除Webhook告警联系人查看文档去调试
DeleteEventBridgeIntegration删除EventBridge通知集成查看文档去调试
DeleteNotificationPolicy根据通知策略ID删除通知策略查看文档去调试
DeleteSilencePolicy根据静默策略ID删除静默策略查看文档去调试
SendTTSVerifyLink为告警联系人发送手机号码验证短信查看文档去调试
Prometheus报警规则(旧版)
OpenAPI 名称描述操作
CreatePrometheusAlertRule创建告警规则查看文档去调试
DescribePrometheusAlertRule查看Prometheus告警规则查看文档去调试
ListPrometheusAlertRules查看Prometheus告警规则列表查看文档去调试
ListPrometheusAlertTemplates查看Prometheus告警模板列表查看文档去调试
UpdatePrometheusAlertRule更新Prometheus报警规则查看文档去调试
DeletePrometheusAlertRule删除Prometheus告警规则查看文档去调试
报警(旧版)
OpenAPI 名称描述操作
CreateAlertContact创建报警联系人查看文档去调试
CreateWebhook创建Webhook告警联系人查看文档去调试
CreateAlertContactGroup创建报警联系人分组查看文档去调试
CreateDispatchRule创建分派策略查看文档去调试
ListActivatedAlerts查询已经触发的告警列表查看文档去调试
SearchAlertRules查询报警规则查看文档去调试
SearchAlertContact查询报警联系人查看文档去调试
SearchAlertContactGroup查询报警联系人分组查看文档去调试
SearchAlertHistories查询报警规则的报警发送记录查看文档去调试
SearchEvents查询报警事件记录查看文档去调试
DescribeDispatchRule查询分派策略信息查看文档去调试
ListDispatchRule查询通知策略列表查看文档去调试
UpdateWebhook修改Webhook告警联系人信息查看文档去调试
UpdateAlertContact更新报警联系人查看文档去调试
UpdateAlertContactGroup更新报警联系人分组查看文档去调试
UpdateAlertRule更新报警规则查看文档去调试
StartAlert启动报警规则查看文档去调试
StopAlert调用StartAlert接口停止报警规则查看文档去调试
UpdateDispatchRule修改分派策略查看文档去调试
DeleteAlertRules删除报警规则查看文档去调试
DeleteAlertContact删除报警联系人查看文档去调试
DeleteAlertContactGroup删除报警联系人分组查看文档去调试
DeleteDispatchRule加快删除指定ID的告警通知策略查看文档去调试
ImportAppAlertRules创建应用报警规则查看文档去调试
访问控制
OpenAPI 名称描述操作
TagResources用于给ARMS资源实例打标签查看文档去调试
ChangeResourceGroup修改资源所属资源组查看文档去调试
UntagResources用于删除ARMS资源实例标签查看文档去调试
OpenArmsServiceSecondVersionhot开通ARMS下指定子产品的后付费功能查看文档去调试
OpenXtraceDefaultSLR开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace查看文档去调试
OpenArmsDefaultSLR开通ARMS服务关联角色AliyunServiceRoleForARMS查看文档去调试
产品计费
OpenAPI 名称描述操作
GetCommercialStatus查看当前账号是否开通对应产品的商业化版本查看文档去调试
CheckCommercialStatus检查产品的商业化开通状态查看文档去调试
QueryCommercialUsage查询写入量数据,支持应用监控、可观测链路OpenTelemetry版、Prometheus、用户体验监控四大产品用量数据查看文档去调试
GetRumOcuStatisticData获取RUM的OCU用量数据查看文档去调试
其他
OpenAPI 名称描述操作
ListEnvironmentKubeResources查看环境的K8s资源查看文档去调试
ListEnvironmentMetricTargets查询环境中的Target列表查看文档去调试
ListEnvironmentAddons查询指定环境安装的Addon信息查看文档去调试
ListEnvironmentAlertRules查询环境中的告警组信息查看文档去调试