跳到主要内容

MetricResourceApi 提供时序数据的读写操作,是 SDK 中最常用的模块之一。

15.1.5.2 指标 API

方法列表

方法HTTP说明
apiV1MetricsGetGET /api/v1/metrics查询指标列表
apiV1MetricsIdHistoryGetGET /api/v1/metrics/{id}/history查询指标历史数据
apiV1MetricsIdLatestGetGET /api/v1/metrics/{id}/latest查询指标最新值
apiV1MetricsIdDataPostPOST /api/v1/metrics/{id}/data向指标写入数据

查询历史数据

返回指定时间范围内的指标数据,支持可选聚合。

参数

名称类型必填说明
idstring指标 ID
fromlong开始时间,Unix 毫秒时间戳
tolong结束时间,Unix 毫秒时间戳
intervalstring聚合时间窗口,如 1m1h。省略则返回原始数据。
aggregatestring聚合函数:avgmaxminsum

返回: MetricDataDTO

示例

// Query the last 1 hour, 1-minute average
long now = System.currentTimeMillis();
long oneHourAgo = now - 3600_000L;

// See the OpenAPI spec or Swagger UI for the full method signature
// MetricResourceApi metricApi = apiClient.buildClient(MetricResourceApi.class);
// MetricDataDTO data = metricApi.apiV1MetricsIdHistoryGet(
// "metric-id-123", oneHourAgo, now, "1m", "avg");

查询最新值

返回指标最近一个数据点,适用于实时监控场景。

示例

// See the OpenAPI spec or Swagger UI for the full method signature
// LatestValueDTO latest = metricApi.apiV1MetricsIdLatestGet("metric-id-123");
// System.out.println("Latest value: " + latest.getValue() + " @ " + latest.getTimestamp());
备注

完整的方法签名和参数请参考 SDK 包中的 OpenAPI 规范文件(idmp-v1.0.14.1.json),或在您的 IDMP 服务器上访问 /swagger-ui.html 浏览 Swagger UI。