文档首页/ 智能设施云平台/ API参考/ API列表/ 能耗管理/ 查询能耗指标的统计数据
更新时间：2025-10-10 GMT+08:00
查看PDF
分享

查询能耗指标的统计数据

功能介绍

查询能耗指标的统计数据

URI

POST /v1/iotfm/energy-eff/boundaries/{boundary_id}/query-metric-data

表1 路径参数

参数

是否必选

参数类型

描述

boundary_id

是

String

边界ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数说明：用户Token。通过调用 生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

X-Instance-Id

是

String

参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。

取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。

X-Root-Zone-Id

否

String

参数说明：项目ID。

取值范围：长度不超过24，只允许字母、数字的组合。
表3 请求Body参数

参数

是否必选

参数类型

描述

start_time

是

String

参数说明：开始时间。

取值范围：格式为："yyyy-MM-dd''T''HH:mm:ss.SSS''Z''"。

end_time

是

String

参数说明：结束时间。

取值范围：格式为："yyyy-MM-dd''T''HH:mm:ss.SSS''Z''"。

metrics

是

Array of strings

参数说明：要查询的指标列表。

取值范围：目前支持的属性路径如下：

ElectricQuantity - 电量指标

WaterQuantity - 用水量指标

ElectricFee - 电费指标

CoolingCapacity - 供冷量指标

HeatCapacity - 供热量指标

AirFlowQuantity - 用气量指标

statistics_tag

否

String

参数说明：时间粒度类型,不传则返回所有原始按小时维度的统计数据。

取值范围：HOUR-小时 DAY-日、WEEK-周、MONTH-月、YEAR-年

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

boundary_id

String

参数说明：边界ID。

取值范围：长度不超过36，只允许字母、数字、以及_-等字符的组合。

metrics

Array of QueryEnergyConsumptionMetricsHistoryItem objects

参数说明：能耗指标统计数据列表
表5 QueryEnergyConsumptionMetricsHistoryItem

参数

参数类型

描述

time

String

时间。

data_points

Map<String,Object>

能耗指标统计数据。key为统计指标，value为属性值。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数说明：错误码。

取值范围：长度8-36。

error_msg

String

参数说明：错误描述。

取值范围：长度2-512。

请求示例

查询能耗指标的统计数据

PUT https://{endpoint}/v1/iotfm/energy-eff/boundaries/{boundary_id}/query-metric-data

{
  "start_time" : "2024-07-18T01:52:49.000Z",
  "end_time" : "2024-07-20T01:52:49.000Z",
  "metrics" : [ "ElectricQuantity", "WaterQuantity", "ElectricFee" ],
  "statistics_tag" : "HOUR"
}

响应示例

无

状态码

状态码

描述

200

查询能耗指标的统计数据响应体

400

Error response

错误码

请参见错误码。

父主题： 能耗管理

相关文档