• 沒有找到結果。

4.1 监控

4.1.4 查询监控数据

功能介绍

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

调试

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

URI

POST /v1/{project_id}/ams/metricdata

4-33 路径参数

参数 是否必选 参数类型 描述

project_id 是 String 租户从IAM申请到的projectid,

一般为32位字符串。

4-34 Query 参数

参数 是否必选 参数类型 描述

fillValue 否 String 用于对查询到的监控数据进行断 点插值,默认值为-1。 -1:断 点处使用-1进行表示。 0 :断 点处使用0进行表示。 null:断 点处使用null进行表示。

average:断点处使用前后邻近 的有效数据的平均值进行表示,

如果不存在有效数据则使用null 进行表示。

缺省值:-1 枚举值:

● -1

● 0

● null

● average

请求参数

4-35 请求 Header 参数

参数 是否必选 参数类型 描述

X-Auth-Token 是 String 从IAM服务获取的用户Token。

Content-Type 是 String 指定类型为application/json。

枚举值:

● application/json

4-36 请求 Body 参数

参数 是否必选 参数类型 描述

metrics 是 Array of MetricQuery MeritcParam objects

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

period 是 Integer 监控数据粒度。 取值范围 枚举

值,取值范围: 60,1分钟粒度 300,5分钟粒度 900,15分钟 粒度 3600,1小时粒度

参数 是否必选 参数类型 描述 statistics 是 Array of

strings 统计方式。 取值范围

maximum,minimum,sum,

average,sampleCount

timerange 是 String 说明: timerange/period≤1440 计算时,timerange和period需 08:00 :00到2017-08-02 08:00:00)可以表示为

1501545600000.15016320000 00.1440。

4-37 MetricQueryMeritcParam

参数 是否必选 参数类型 描述

dimensions 是 Array of Dimension

metricName 是 String 指标名称。名称长度取值范围为 1~255个字符。 取值范围:

namespace 是 String 指标命名空间。 取值范围:

PAAS.CONTAINER:组件指 标、实例指标、进程指标和容器 指标的命名空间,

PAAS.NODE: 主机指标、网络 指标、磁盘指标和文件系统指标 的命名空间, PAAS.SLA:SLA 指标的命名空间,

PAAS.AGGR:集群指标的命名 空间, CUSTOMMETRICS:默 认的自定义指标的命名空间。

4-38 Dimension

参数 是否必选 参数类型 描述

name 是 String 维度名称。

value 是 String 维度取值。

响应参数

状态码: 200

4-39 响应 Body 参数

参数 参数类型 描述

errorCode String 响应码。

errorMessage String 响应信息描述。

metrics Array of MetricDataV alue objects

指标对象列表。

4-40 MetricDataValue

参数 参数类型 描述

dataPoints Array of MetricDataP oints objects

重点指标。

metric MetricQuery MeritcParam object

查询参数集

4-41 MetricDataPoints

参数 参数类型 描述

statistics Array of StatisticValu e objects

统计方式。

timestamp Long 时间戳。

unit String 时间序列单位。

4-42 StatisticValue

参数 参数类型 描述

statistic String 统计方式。

value Double 统计结果。

4-43 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:默认的自定义指标的命名空 间。

4-44 Dimension

参数 参数类型 描述

name String 维度名称。

value String 维度取值。

请求示例

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

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.2000", "errorMessage" : "success", "metrics" : [ {

"timestamp" : "1467892800000", "unit" : "Percent",

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

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

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

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

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

错误码

请参见错误码。