跳转到主要内容
平台运维/云平台监控相关接口/监控报警/通知服务/监控报警相关接口/时序数据(Metric)

获取metric数据

获取metric数据

GET/zstack/v1/zwatch/metrics

操作 ID

GetMetricData

起始版本

2.3

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • namespace
    String必填

    名字空间

  • metricName
    String必填

    监控项

  • startTime
    Long

    起始时间

  • endTime
    Long

    结束时间

  • period
    Integer

    数据精度

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • error
    ErrorCode必填

    错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error

    • code
      String必填

      错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段,默认为null

    • opaque
      LinkedHashMap必填

      保留字段,默认为null

    • cause
      ErrorCode必填

      根错误,引发当前错误的源错误,若无原错误,该字段为null

  • data
    List必填

    详情参考data

    • value
      double必填

      监控值

    • time
      long必填

      记录生成时间

    • labels
      Map必填

      标签