检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 非联通用户请查看设备接入服务。 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括设备管理、数据采集、命令下发、设备升级等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表
批量处理 应用服务器通过批量处理接口,对已接入物联网平台的设备进行批量操作。 创建批量任务 查询指定批量任务信息 查询批量任务的子任务信息 父主题: 应用侧API参考(联通用户专用)
命令下发 创建设备命令 查询设备命令 修改设备命令 批量创建设备命令 创建设备命令撤销任务 查询设备命令撤销任务 设备命令下发 父主题: 应用侧API参考(联通用户专用)
应用安全接入 应用服务器获取鉴权信息,接入物联网平台,随后携带鉴权信息调用其他API接口。 鉴权 刷新token 父主题: 应用侧API参考(联通用户专用)
数据转发规则 规则管理为应用服务器提供物联网平台的规则引擎功能,通过设置规则实现业务的联动变化。 规则引擎包含触发源、条件、动作三部分。规则引擎接收触发源事件,满足规则配置的条件后触发相应动作。 触发源:表示触发规则的事件源,当前支持的触发源有设备数据上报和时间。 条件:表示规则触发依赖相关的条件
数据采集 物联网平台支持应用服务器查询设备的基本信息,同时还支持查看设备上报的历史数据,能按时、天,月等维度查看设备上报的历史数据。 查询单个设备信息 批量查询设备信息 查询设备历史数据 查询设备影子历史数据 查询设备服务能力 父主题: 应用侧API参考(联通用户专用)
设备升级 查询版本包列表 查询指定版本包 删除指定版本包 创建软件升级任务 创建固件升级任务 查询指定任务信息 查询指定任务的子任务详情 查询任务列表 父主题: 应用侧API参考(联通用户专用)
删除设备 接口说明 已在物联网平台注册的设备,若不再需要接入平台时,应用服务器可调用此接口在物联网平台删除设备,使设备无法再接入平台。后续设备若需要再次接入平台,则需重新注册设备。 URI 请求方法 DELETE URI /iocm/app/dm/v1.4.0/devices/{deviceId
创建批量任务 接口说明 应用服务器若需要对多个设备进行批量操作时,可调用此接口创建设备的批量操作任务,当前仅支持给批量设备下发缓存命令。 URI 请求方法 POST URI /iocm/app/batchtask/v1.1.0/tasks 传输协议 HTTPS 请求参数 参数 必选
修改规则 接口说明 应用服务器可调用此接口修改物联网平台中指定规则的配置。 调试 您可以在API Explorer中直接运行调试该接口。 URI 请求方法 PUT URI /v5/iot/{project_id}/rules/{rule_id} 传输协议 HTTPS 请求参数 名称
设备管理 应用服务器向物联网平台添加设备,获取设备的ID和验证码,待设备完成接入物联网平台流程后,设备与应用服务器建立从属关系。 注册设备(验证码方式) 注册设备(密码方式) 刷新设备密钥 修改设备信息 删除设备 删除子设备 查询设备激活状态 修改设备影子 查询设备影子 注册LoRa
刷新token 接口说明 应用服务器通过鉴权接口获取到的accessToken是有效时间的,在accessToken快过期时,应用服务器通过调用此接口,获取新的accessToken。 URI 请求方法 POST URI /iocm/app/sec/v1.1.0/refreshToken
注册LoRa网关 接口说明 loraServer网关上线后,注册LoRa网关。 注意事项 应用已鉴权,在header中携带参数app_key和Authorization: Bearer {accessToken} URI 请求方法 POST URI /api/v3.0/devices
删除LoRa网关 接口说明 删除LoRa网关。 注意事项 应用已鉴权,在header中携带参数app_key和Authorization: Bearer {accessToken} URI 请求方法 DELETE URI /api/v3.0/devices/lora/gateway
查询指定任务信息 接口说明 在创建了设备软件升级任务或固件升级任务后,应用服务器可调用此接口查询某个升级任务详细信息,以查看升级任务的配置信息和执行情况等。 URI 请求方法 GET URI /iodm/northbound/v1.5.0/operations/{operationId
查询指定版本包 接口说明 在进行设备版本升级前,应用服务器可调用此接口在物联网平台查询某个版本升级包的信息,确保设备要升级的版本包已上传到平台,可根据版本包ID查询指定版本包信息,在调用该接口前需要通过查询版本包列表接口查询获得版本包ID。 URI 请求方法 GET URI /iodm
鉴权 接口说明 应用服务器首次访问物联网平台的开放API时,需调用此接口完成认证鉴权,获取accessToken。 注意事项 鉴权接口是调用其他API的前提,除了调用鉴权接口,其他接口调用都需要在request header中携带参数app_key和Authorization。app_key
设备命令下发 接口说明 设备Profile文件中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。 物联网平台不对设备命令进行缓存而是直接下发命令,设备不在线时命令下发失败。下发命令的具体格式需要应用服务器与设备自定义
注册LoRa节点 接口说明 loraServer网关上线后,注册LoRa节点。 注意事项 应用已鉴权,在header中携带参数app_key和Authorization: Bearer {accessToken} URI 请求方法 POST URI /api/v3.0/devices
推送通知 应用服务器向物联网平台订阅设备信息,当设备信息发生变更时,物联网平台向应用服务器推送此消息,应用服务器根据通知类型对消息分派处理。需要配合订阅管理接口使用。 注册设备通知 绑定设备通知 设备信息变化通知 设备数据变化通知 设备数据批量变化通知 设备服务能力变化通知 设备服务能力增加通知