查询空间下能耗排行

更新时间:2021-09-30 09:23:58下载pdf

本文介绍查询空间下能耗排行的 API。

接口描述

查询一定时间范围内,空间下的能源排行,包括水、电、气的使用、生成或转储统计数据。

接口地址

GET: /v1.0/iot-03/energy/{energy_type}/space/statistics-top

请求参数

参数名 类型 参数位置 是否必填 说明
energy_type String uri true 能源类型,仅支持电: electricity
energy_action String query true 能源行为,仅支持消耗: consume
statistics_type String query true 统计粒度,
  • month:月,格式为 yyyyMM,最大跨度12个月,只能查询最近一年的数据
  • day:天,格式为 yyyyMMdd,最大跨度7天,只能查询最近 90 天的数据
  • hour:小时,格式为 yyyyMMddHH,最大跨度 24 小时,只能查询最近 7 天的数据
start_time String query true 开始时间
end_time String query true 结束时间
depth Integer query false 空间层级,默认层级为 0,即空间下第一层级,层级取值范围为 0~9
limit Integer query false 统计的个数限制,默认10,最大值为 100
contain_childs Boolean query false 是否包含子节点数据,默认true

返回参数

参数名 类型 说明
result List

result 说明

参数名 类型 说明
value Float 能耗
space_id String 空间 ID

请求示例

GET: /v1.0/iot-03/energy/electricity/space/statistics-top?energy_action=consume&statisticsType=day&startTime=20210923&endTime=20210924&depth=1&containChilds=true

返回示例

{ "result": [ { "space_id": "xxx", "value": 1.1 } ], "t": 1624525873263, "success": true }

错误码

参考 错误码