文档首页 > > API参考> API> 监控>

查询时序数据

查询时序数据

分享
更新时间:2020/12/24 GMT+08:00

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/samples

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串。

表2 Query参数

参数

是否必选

参数类型

描述

fill_value

String

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

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

samples

Array of QuerySample objects

取值范围 JSON数组大小不超过20 时序数据对象列表。

statistics

Array of strings

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

period

Integer

监控数据粒度。 取值范围 枚举值,取值范围: 60,1分钟粒度 300,5分钟粒度 900,15分钟粒度 3600,1小时粒度

time_range

String

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

表4 QuerySample

参数

是否必选

参数类型

描述

namespace

String

时间序列的命名空间。 取值范围 PAAS.CONTAINER PAAS.NODE PAAS.SLA PAAS.AGGR CUSTOMMETRICS

dimensions

Array of Dimension objects

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

metric_name

String

时间序列名称。 取值范围 名称长度为1~255个字符

表5 Dimension

参数

是否必选

参数类型

描述

name

String

名称。

value

String

具体数值。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

samples

Array of SampleDataValue objects

时间序列对象列表。

表7 SampleDataValue

参数

参数类型

描述

sample

QuerySample object

时间序列对象列表。

data_points

Array of MetricDataPoints objects

时序数据。

表8 QuerySample

参数

参数类型

描述

namespace

String

时间序列的命名空间。 取值范围 PAAS.CONTAINER PAAS.NODE PAAS.SLA PAAS.AGGR CUSTOMMETRICS

dimensions

Array of Dimension objects

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

metric_name

String

时间序列名称。 取值范围 名称长度为1~255个字符

表9 Dimension

参数

参数类型

描述

name

String

名称。

value

String

具体数值。

表10 MetricDataPoints

参数

参数类型

描述

timestamp

Long

时间戳。

unit

String

时间序列单位。

statistics

Array of StatisticValue objects

统计方式。

表11 StatisticValue

参数

参数类型

描述

statistic

String

统计方式。

value

Double

统计结果。

状态码: 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息描述。

error_type

String

错误类型。

请求示例

{ 
    "samples": [ 
        { 
            "namespace": "abc", 
            "metric_name": "def", 
            "dimensions": [ 
                { 
                    "name": "instance_id", 
                    "value": "demo1" 
                } 
            ] 
        } 
    ], 
    "period": 60, 
    "time_range": "-1.-1.5",// 最近5分钟
      "statistics": [ 
        "maximum", 
        "minimum", 
        "sum" 
    ] 
}

响应示例

状态码: 200

编码 OK 请求执行完成。

{
  "samples" : [ {
    "sample" : {
      "namespace" : "abc",
      "metric_name" : "def",
      "dimensions" : [ {
        "name" : "ghi",
        "value" : "lmn"
      } ]
    },
    "data_points" : [ {
      "timestamp" : "1467892800000",
      "unit" : "Percent",
      "statistics" : [ {
        "statistic" : "maximum",
        "value" : "23"
      } ]
    } ]
  } ]
}

状态码: 400

编码: BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

{
  "error_code" : "AOM.04008500",
  "error_msg" : "internal server error",
  "error_type" : "INTERNAL_SERVER_ERROR"
}

状态码

状态码

描述

200

编码 OK 请求执行完成。

400

编码: BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

401

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

403

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

500

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

503

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

错误码

请参见错误码

分享:

    相关文档

    相关产品