应用监控
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
GetTraceApp![]() | 获取应用监控任务详情 | 查看文档去调试 |
GetAppJVMConfig | 获取应用各个实例的JVM配置信息 | 查看文档去调试 |
QueryAppTopology | 查询应用拓扑 | 查看文档去调试 |
GetAppApiByPage![]() | 通过分页的形式查询应用下每个接口的请求量、错误数、平均响应时间三种性能数据。可通过返回信息中的Completed字段判断分页是否结束。如未结束,CurrentPage参数加一后继续发起查询即可 | 查看文档去调试 |
GetTrace![]() | 加快获取调用链详情 | 查看文档去调试 |
GetStack | 获取调用链方法栈信息 | 查看文档去调试 |
GetMultipleTrace | 获取多个调用链的详情 | 查看文档去调试 |
GetTraceAppConfig | 查询应用监控中,某个应用的全部自定义设置(如调用链采样设置、Agent开关等)。此接口仅适用于接入应用监控的应用,不适用于接入可观测链路 OpenTelemetry 版的应用 | 查看文档去调试 |
QueryReleaseMetric | 查询EDAS和K8s应用发布过程中不同版本的指标 | 查看文档去调试 |
ListTraceApps![]() | 获取指定地域下全部应用监控任务的列表 | 查看文档去调试 |
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 名称 | 描述 | 操作 |
---|---|---|
CreateTimingSyntheticTask | 创建定时拨测任务(新版) | 查看文档去调试 |
GetSyntheticMonitors | 获取拨测点 | 查看文档去调试 |
GetTimingSyntheticTask | 获取任务详情 | 查看文档去调试 |
ListSyntheticDetail | 获取拨测结果 | 查看文档去调试 |
UpdateTimingSyntheticTask | 更新定时拨测任务 | 查看文档去调试 |
StopTimingSyntheticTask | 停止定时拨测任务 | 查看文档去调试 |
StartTimingSyntheticTask | 启动定时拨测任务 | 查看文档去调试 |
DeleteTimingSyntheticTask | 删除定时拨测任务 | 查看文档去调试 |
ListTimingSyntheticTasks | 获取定时拨测任务列表 | 查看文档去调试 |
告警管理(新版)
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateIntegration | 创建告警集成 | 查看文档去调试 |
CreateOrUpdateAlertRule![]() | 创建或修改告警规则 | 查看文档去调试 |
CreateOrUpdateContact | 创建或者修改告警联系人 | 查看文档去调试 |
CreateOrUpdateContactGroup | 创建或修改告警联系人组 | 查看文档去调试 |
CreateOrUpdateIMRobot | 创建或更新IM机器人 | 查看文档去调试 |
CreateOrUpdateWebhookContact | 创建或修改Webhook告警联系人 | 查看文档去调试 |
CreateOrUpdateEventBridgeIntegration | 创建或修改EventBridge通知集成 | 查看文档去调试 |
CreateOrUpdateNotificationPolicy | 创建或更新通知策略 | 查看文档去调试 |
CreateOrUpdateSilencePolicy | 创建或修改静默策略 | 查看文档去调试 |
ListIntegration | 查看集成列表详情 | 查看文档去调试 |
ListAlertEvents![]() | 查询告警事件历史 | 查看文档去调试 |
GetAlertRules![]() | 查询已经创建的告警规则 | 查看文档去调试 |
DescribeContacts | 查询告警联系人列表 | 查看文档去调试 |
DescribeContactGroups | 查询告警联系人分组信息 | 查看文档去调试 |
DescribeIMRobots | 查询IM机器人列表 | 查看文档去调试 |
DescribeWebhookContacts | 查询Webhook告警联系人列表 | 查看文档去调试 |
ListEventBridgeIntegrations | 查询EventBridge通知集成信息 | 查看文档去调试 |
ListNotificationPolicies | 通过指定条件查询通知策略信息 | 查看文档去调试 |
ListEscalationPolicies | 查询升级策略信息 | 查看文档去调试 |
ListOnCallSchedules | 查询排班策略信息 | 查看文档去调试 |
GetOnCallSchedulesDetail | 查询排班策略信息 | 查看文档去调试 |
ListSilencePolicies | 查询静默策略列表信息 | 查看文档去调试 |
ListAlerts![]() | 告警发送历史接口 | 查看文档去调试 |
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资源实例标签 | 查看文档去调试 |
OpenArmsServiceSecondVersion![]() | 开通ARMS下指定子产品的后付费功能 | 查看文档去调试 |
OpenXtraceDefaultSLR | 开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace | 查看文档去调试 |
OpenArmsDefaultSLR | 开通ARMS服务关联角色AliyunServiceRoleForARMS | 查看文档去调试 |