检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
设备升级 查询版本包列表 查询指定版本包 删除指定版本包 创建软件升级任务 创建固件升级任务 查询指定任务信息 查询指定任务的子任务详情 查询任务列表 父主题: 应用侧API参考(联通用户专用)
使用前必读 非联通用户请查看设备接入服务。 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括设备管理、数据采集、命令下发、设备升级等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。
删除设备 接口功能 当有新设备需要从网关移除时,通过调用设备删除接口将非直连设备从物联网平台删除。 接口描述 1 HW_INT IOTA_HubDeviceRemove(HW_UINT uiCookie, const HW_CHAR *pcDeviceId); 参数说明 字段 必选/可选
设备组管理 创建设备组 删除设备组 修改设备组 查询设备组列表 查询指定设备组 查询指定设备组成员 增加设备组成员 删除设备组成员 父主题: 应用侧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 请求参数 参数 必选/可选
订阅管理-V3 物联网平台支持应用服务器对设备数据的订阅,若订阅的设备信息有变更,平台会推送给应用服务器。消息订阅接口需要与推送通知接口配合使用。 订阅平台业务数据 订阅平台管理数据 查询单个订阅 批量查询订阅 删除单个订阅 批量删除订阅 推送通知 父主题: 应用侧API参考(联通用户专用)
查询设备命令 接口说明 应用服务器向设备下发命令后,可调用此接口在物联网平台查询下发命令的状态及内容信息,以了解命令的执行情况,可查询指定时间段内本应用下的所有下发命令,或者指定设备的所有下发命令。 URI 请求方法 GET URI /iocm/app/cmd/v1.4.0/deviceCommands
修改设备命令 接口说明 应用服务器向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行,此时应用服务器可调用此接口修改该命令的状态信息。仅能修改还处于PENDING状态的命令,且当前仅支持把命令状态修改为CANCELED状态,即撤销命令的执行。
订阅管理-V5 查询订阅列表 创建订阅 查询订阅 修改订阅 删除订阅 推送通知 父主题: 应用侧API参考(联通用户专用)
应用安全接入 应用服务器获取鉴权信息,接入物联网平台,随后携带鉴权信息调用其他API接口。 鉴权 刷新token 父主题: 应用侧API参考(联通用户专用)
数据转发规则 规则管理为应用服务器提供物联网平台的规则引擎功能,通过设置规则实现业务的联动变化。 规则引擎包含触发源、条件、动作三部分。规则引擎接收触发源事件,满足规则配置的条件后触发相应动作。 触发源:表示触发规则的事件源,当前支持的触发源有设备数据上报和时间。 条件:表示规则
刷新token 接口说明 应用服务器通过鉴权接口获取到的accessToken是有效时间的,在accessToken快过期时,应用服务器通过调用此接口,获取新的accessToken。 URI 请求方法 POST URI /iocm/app/sec/v1.1.0/refreshToken
查询指定版本包 接口说明 在进行设备版本升级前,应用服务器可调用此接口在物联网平台查询某个版本升级包的信息,确保设备要升级的版本包已上传到平台,可根据版本包ID查询指定版本包信息,在调用该接口前需要通过“查询版本包列表”接口查询获得版本包ID。 URI 请求方法 GET URI /iodm/northbound/v1
查询指定任务信息 接口说明 在创建了设备软件升级任务或固件升级任务后,应用服务器可调用此接口查询某个升级任务详细信息,以查看升级任务的配置信息和执行情况等。 URI 请求方法 GET URI /iodm/northbound/v1.5.0/operations/{operationId}
查询单个设备信息 接口说明 已在物联网平台注册的设备,应用服务器若需要查看某个设备的详细信息(如厂商、型号、版本、状态和服务属性等信息),可调用此接口在物联网平台查询获取。 URI 请求方法 GET URI /iocm/app/dm/v1.4.0/devices/{deviceId}
查询设备服务能力 接口说明 应用服务器若需要了解设备可上报哪些服务属性数据,以及设备支持下发哪些命令,可调用此接口在物联网平台查询设备的Profile文件中定义的设备服务能力信息。 URI 请求方法 GET URI /iocm/app/data/v1.1.0/deviceCapabilities
推送通知 应用服务器向物联网平台订阅设备信息,当设备信息发生变更时,物联网平台向应用服务器推送此消息,应用服务器根据通知类型对消息分派处理。需要配合订阅管理接口使用。 注册设备通知 绑定设备通知 设备信息变化通知 设备数据变化通知 设备数据批量变化通知 设备服务能力变化通知 设备服务能力增加通知