公共内容

功能介绍

查询云监控服务监控概览、控制服务状态、存储集群状态、节点状态、其它服务(RabbitMQ、Etcd)、告警消息页面的数据。

前提条件

• 签名机制使用Token认证，调用各页面API均需提供云管理员身份验证生成的project级别的Token。
• Dashboard页面接口需提供云管理员身份验证生成的domain级别的Token。

  URI

  GET http://emla.{address}/apis/monitoring/v1/ecms/{route}

参数	是否必选	描述
address	是	根域名，默认openstack.svc.cluster.local，以下省略此部分
route	是	各页面对应路由。

公共请求消息

参数	参数类型	是否必选	描述	默认值
metrics_filter	String	否	正则表达式，指定要查询的metrics	所有metrics
start	String	否	Unix时间格式，查询开始时间
end	String	否	Unix时间格式，查询结束时间
step	String	否	时间间隔	10m
time	String	否	时间戳，Unix时间格式 查询某时间点	Now

说明：

• 以上均为可选参数，若不指定metrics_filter，则查询所有metrics并返回结果；
• 正则表达式：string1|string2|…
• 使用start和end来查询一段时间内的metric数据；
• step：配合start和end，以固定的时间间隔查询metric数据。格式为[0-9] + [smhdwy]；
• time：它与start，end，step的组合是互斥的。

公共响应消息

参数	描述
results	查询结果
metric_name	metric名称
data	结果数据
resultType	数据类型 vector 或 matrix
result	结果列表
metric	存放label信息
value	时间戳和值

公共示例

单点值

• Now

  cURI -H 'X-Auth-Token: XXXXXX' 'http://emla.openstack.svc.cluster.local/apis/monitoring/v1/ecms/{route}?metrics_filter=**'
  {
      "results": [
          {
              "metric_name": "**",
              "data": {
                  "resultType": "vector",
                  "result": [
                      {
                          "value": [
                              1610445242.231,
                              "0"
                          ]
                      }
                  ]
              }
          }
      ]
  }

• 指定具体时间点

  cURI -H 'X-Auth-Token: XXXXXX' 'http://emla.openstack.svc.cluster.local/apis/monitoring/v1/ecms/{route}?metrics_filter=**&time=1612255196'
  {
      "results": [
          {
              "metric_name": "**",
              "data": {
                  "resultType": "vector",
                  "result": [
                      {
                          "value": [
                              1612255196,
                              "0"
                          ]
                      }
                  ]
              }
          }
      ]
  }

• 连续时间序列

  cURI -H 'X-Auth-Token: XXXXXX' 'http://emla.openstack.svc.cluster.local/apis/monitoring/v1/ecms/{route}?metrics_filter=dashboard_**&start=1610434791&end=1610438391&step=30s'
  {
   "results": [
    {
     "metric_name": "**",
     "data": {
      "resultType": "matrix",
      "result": [
       {
        "values": [
         [
          1610434791,
          "0"
         ],
         [
          1610434821,
          "0"
         ],
         ...
         [
          1610438391,
          "0"
         ]
        ]
       }
      ]
     }
    }
   ]
  }

  空值

• metric不正确

  ?metrics_filter=dashboard_error
  {
      "results": null
  }

• metric正确，返回值为空

  {
      "results": [
          {
              "metric_name": "**",
              "data": {
                  "resultType": "vector/matrix"
              }
          }
      ]
  }

  异常返回

• 参数冲突、Token缺失等接口错误

  {"error":"***"}

• 内部服务异常、连接超时等错误

  {
      "results": [
          {
              "metric_name": "dashboard_**",
              "data": {},
              "error": "***"
          }
      ]
  }

说明：
以上公共请求参数、公共响应消息、公共示例仅适用于监控概览、控制服务状态、存储集群状态、节点状态、其它服务(RabbitMQ、Etcd)页面，告警消息相关内容将单独说明。