文档首页> 应用运维管理 AOM> API参考（吉隆坡区域）> API> 监控> 查询监控数据
更新时间：2022-08-11 GMT+08:00
查看PDF

查询监控数据

功能介绍

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

URI

POST /v1/{project_id}/ams/metricdata

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。
表2 Query参数

参数

是否必选

参数类型

描述

fillValue

否

String

用于对查询到的监控数据进行断点插值，默认值为-1。 -1：断点处使用-1进行表示。 0 ：断点处使用0进行表示。 null：断点处使用null进行表示。 average：断点处使用前后邻近的有效数据的平均值进行表示，如果不存在有效数据则使用null进行表示。

枚举值：

  • -1

  • 0

  • null

  • average

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

Content-Type

是

String

指定类型为application/json。

枚举值：

  • application/json
表4 请求Body参数

参数

是否必选

参数类型

描述

metrics

是

Array of MetricQueryMeritcParam objects

指标对象列表。 取值范围 JSON数组大小不超过20

period

是

Integer

监控数据粒度。 取值范围 枚举值，取值范围：

  • 60：1分钟粒度；

  • 300：5分钟粒度；

  • 900：15分钟粒度；

  • 3600：1小时粒度。

枚举值：

  • 60

  • 300

  • 900

  • 3600

statistics

是

Array of strings

统计方式。 取值范围 maximum，minimum，sum，average，sampleCount

timerange

是

String

说明： timerange/period≤1440 计算时，timerange和period需换算为相同的单位。 取值范围 格式：开始时间UTC毫秒.结束时间UTC毫秒.时间范围分钟数。开始和结束时间为-1时，表示最近N分钟，N为时间范围分钟取值。 查询时间段，如最近五分钟可以表示为-1.-1.5，固定的时间范围（2017-08-01 08:00 :00到2017-08-02 08:00:00）可以表示为1501545600000.1501632000000.1440。
表5 MetricQueryMeritcParam

参数

是否必选

参数类型

描述

dimensions

是

Array of Dimension objects

指标维度列表。 取值范围： 数组不能为空，同时数组中任何一个dimension对象name和value属性的值也不能为空。

metricName

是

String

指标名称。名称长度取值范围为1~255个字符。 取值范围： AOM提供的基础指标， cpuUsage、cpuCoreUsed等 cpuUage：cpu使用率； cpuCoreUsed：cpu内核占用； 用户上报的自定义指标名称。

namespace

是

String

指标命名空间。 取值范围： PAAS.CONTAINER：组件指标、实例指标、进程指标和容器指标的命名空间， PAAS.NODE： 主机指标、网络指标、磁盘指标和文件系统指标的命名空间， PAAS.SLA：SLA指标的命名空间， PAAS.AGGR：集群指标的命名空间， CUSTOMMETRICS：默认的自定义指标的命名空间。
表6 Dimension

参数

是否必选

参数类型

描述

name

是

String

维度名称。

value

是

String

维度取值。

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

errorCode

String

响应码。

errorMessage

String

响应信息描述。

metrics

Array of MetricDataValue objects

指标对象列表。
表8 MetricDataValue

参数

参数类型

描述

dataPoints

Array of MetricDataPoints objects

重点指标。

metric

MetricQueryMeritcParam object

查询参数集
表9 MetricDataPoints

参数

参数类型

描述

statistics

Array of StatisticValue objects

统计方式。

timestamp

Long

时间戳。

unit

String

时间序列单位。
表10 StatisticValue

参数

参数类型

描述

statistic

String

统计方式。

value

Double

统计结果。
表11 MetricQueryMeritcParam

参数

参数类型

描述

dimensions

Array of Dimension objects

指标维度列表。 取值范围： 数组不能为空，同时数组中任何一个dimension对象name和value属性的值也不能为空。

metricName

String

指标名称。名称长度取值范围为1~255个字符。 取值范围： AOM提供的基础指标， cpuUsage、cpuCoreUsed等 cpuUage：cpu使用率； cpuCoreUsed：cpu内核占用； 用户上报的自定义指标名称。

namespace

String

指标命名空间。 取值范围： PAAS.CONTAINER：组件指标、实例指标、进程指标和容器指标的命名空间， PAAS.NODE： 主机指标、网络指标、磁盘指标和文件系统指标的命名空间， PAAS.SLA：SLA指标的命名空间， PAAS.AGGR：集群指标的命名空间， CUSTOMMETRICS：默认的自定义指标的命名空间。
表12 Dimension

参数

参数类型

描述

name

String

维度名称。

value

String

维度取值。

请求示例

查询指定指标最近5分钟的监控数据。

POST https://{Endpoint}/v1/{project_id}/ams/metricdata

{
  "metrics" : [ {
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "demo1"
    } ],
    "metricName" : "def",
    "namespace" : "abc"
  } ],
  "period" : 60,
  "statistics" : [ "maximum", "minimum", "sum" ],
  "timerange" : "-1.-1.5"
}

响应示例

状态码： 200

OK

请求执行完成。

{
  "errorCode" : "SVCSTG_AMS_2000000",
  "errorMessage" : "success",
  "metrics" : [ {
    "metric" : {
      "namespace" : "abc",
      "metricName" : "def",
      "dimensions" : [ {
        "name" : "ghi",
        "value" : "lmn"
      } ]
    },
    "dataPoints" : [ {
      "timestamp" : "1467892800000",
      "unit" : "Percent",
      "statistics" : [ {
        "statistic" : "maximum",
        "value" : "23"
      } ]
    } ]
  } ]
}

状态码

状态码

描述

200

OK

请求执行完成。

400

BadRequest

非法请求。建议直接修改该请求，不要重试该请求。

401

Unauthorized

在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

403

Forbidden

请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

500

InternalServerError

表明服务端能被请求访问到，但是不能理解用户的请求。

503

ServiceUnavailable

被请求的服务无效。建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题： 监控