更新时间:2024-04-15 GMT+08:00

API概览

应用运维管理服务API为开发者、合作伙伴提供监控、弹性伸缩、日志开放接口,帮助您快速、低成本地实现应用运维。

表1 API概览

类型

说明

监控(v1)

监控相关的接口,包括查询指标,查询、添加监控数据,添加、修改、查询、删除阈值规则,添加、修改、查询、删除应用发现规则接口。

监控(v2)

监控相关的接口,包含查询时间序列,查询时序数据,添加、修改、查询、删除阈值规则接口。

说明:

v2接口为新开放接口,建议用户使用新接口。

v1接口为老接口,不建议新用户使用,后续版本会下线。

弹性伸缩

弹性伸缩相关的接口,包括创建、删除、更新策略,查看单个和所有策略,更新、查询策略组属性接口。

日志

日志相关的接口,包括查询日志接口。

事件告警

告警上报相关的接口,包括上报事件告警信息接口。

Agent

查询Agent信息接口。

应用发现规则

添加、修改、查询、删除应用发现规则接口。

Prometheus监控

prometheus监控相关的接口,包括区间数据查询、瞬时数据查询、查询标签值、获取标签名列表、元数据查询接口。

监控(v1)

API

说明

查询指标

查询当前可监控的指标列表,可以指定指标命名空间、指标名称、维度、所属资源的编号(格式为:resType_resId),分页查询的起始位置和返回的最大记录条数。

查询监控数据

查询指定时间范围内的监控数据,可以通过参数指定需要查询的数据维度,数据周期等。

添加监控数据

添加单条或多条监控数据。

添加阈值规则

添加单条阈值规则。

修改阈值规则

修改单条阈值规则。

查询阈值规则列表

查询所有阈值规则。

查询单条阈值规则

查询单条阈值规则。

删除阈值规则

删除单条阈值规则。

添加或修改应用发现规则

添加、修改单条或多条应用发现规则。

删除应用发现规则

删除单条或多条应用发现规则。

查询应用发现规则

查询当前已存在的应用发现规则。

监控(v2)

API

说明

查询时间序列

该接口用于查询系统当前可监控的时间序列列表,可以指定时间序列命名空间、名称、维度、所属资源的编号(格式为:resType_resId)。

查询时序数据

该接口用于查询指定时间范围内的监控时序数据,可以通过参数指定需要查询的数据维度,数据周期等。

添加阈值规则

添加单条阈值规则。

查询阈值规则列表

查询所有阈值规则。

修改阈值规则

修改单条阈值规则。

删除阈值规则

删除单条阈值规则。

查询单条阈值规则

查询单条阈值规则。

批量删除阈值规则

删除多条阈值规则。

弹性伸缩

API

说明

创建策略

创建策略。

查看策略列表

查询指定项目下所有策略的详细信息。

删除策略

删除指定策略。

更新策略

更新策略。

查看单个策略

查询指定项目下单个策略的详细信息。

更新策略组属性

更新策略组属性。

查询策略组属性

查询策略组属性。

日志

API

说明

查询日志

查询不同维度(例如,集群、IP、应用等)下的日志内容。

事件告警

API

说明

查询事件告警信息

该接口用于查询对应用户的事件、告警 。

统计事件告警信息

该接口用于分段统计指定条件下的事件、告警。

上报事件告警信息

上报对应用户的事件、告警。

Agent

API

说明

查询Agent信息

查询对应账号,集群,命名空间下的Agent信息。

应用发现规则

API

说明

添加或修改应用发现规则

添加、修改单条或多条应用发现规则。

删除应用发现规则

删除单条或多条应用发现规则。

查询应用发现规则

查询当前已存在的应用发现规则。

Prometheus监控

API

说明

区间数据查询

查询PromQL(Prometheus Query Language)在一段时间返回内的计算结果。

瞬时数据查询

查询PromQL(Prometheus Query Language) 在特定时间点下的计算结果。

查询标签值

查询带有指定标签的时间序列列表。

获取标签名列表

获取标签名列表。

元数据查询

查询序列及序列标签的元数据。

根据Prometheus实例查询区间数据

根据Prometheus实例查询PromQL(Prometheus Query Language)在一段时间返回内的计算结果。

根据Prometheus实例查询瞬时数据

根据Prometheus实例查询PromQL(Prometheus Query Language)在特定时间点下的计算结果。

根据Prometheus实例查询标签值

根据Prometheus实例查询带有指定标签的时间序列列表。

根据Prometheus实例获取标签名列表

根据Prometheus实例获取标签名列表。

根据Prometheus实例查询元数据

根据Prometheus实例查询序列及序列标签的元数据。