检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除设备 接口说明 已在物联网平台注册的设备,若不再需要接入平台时,应用服务器可调用此接口在物联网平台删除设备,使设备无法再接入平台。后续设备若需要再次接入平台,则需重新注册设备。 URI 请求方法 DELETE URI /iocm/app/dm/v1.4.0/devices/{deviceId
批量删除订阅 接口说明 应用服务器若不再需要接收物联网平台推送的订阅通知消息,或者不再需要接收某类订阅通知消息,可调用此接口批量删除订阅配置,取消订阅,可删除全部订阅,或删除指定订阅类型的所有订阅,或删除指定回调URL地址的所有订阅。 URI 请求方法 DELETE URI /iocm
设备接收命令 接口说明 设备接收物联网平台下发的控制命令。 Topic Topic /huawei/v1/devices/{deviceId}/command/{codecMode} 消息发送方 物联网平台 消息接收方 设备 参数说明 参数 必选/可选 类型 描述 msgType
创建批量任务 接口说明 应用服务器若需要对多个设备进行批量操作时,可调用此接口创建设备的批量操作任务,当前仅支持给批量设备下发缓存命令。 URI 请求方法 POST URI /iocm/app/batchtask/v1.1.0/tasks 传输协议 HTTPS 请求参数 参数 必选
鉴权 典型场景 第三方应用首次访问物联网平台的开放API时,需调用此接口完成接入认证;第三方应用在物联网平台的认证过期后,需调用此接口重新进行认证,才能继续访问物联网平台的开放API。 接口功能 支持第三方应用在首次访问物联网平台的开放API之前,完成在物联网平台的接入认证。 注意事项
订阅平台管理数据 典型场景 第三方应用可向物联网平台订阅设备相关的管理数据,当物联网平台中设备进行版本升级等相关操作时,平台会向第三方应用发送通知消息,知会其具体的操作状态或操作结果信息。第三方应用可以调用此接口向物联网平台订阅不同类型的设备升级操作通知。 接口功能 支持第三方应用向物联网平台订阅设备的升级操作信息
查询指定版本包 接口说明 在进行设备版本升级前,应用服务器可调用此接口在物联网平台查询某个版本升级包的信息,确保设备要升级的版本包已上传到平台,可根据版本包ID查询指定版本包信息,在调用该接口前需要通过“查询版本包列表”接口查询获得版本包ID。 URI 请求方法 GET URI /
设备激活通知 接口说明 应用服务器在物联网平台订阅了设备激活通知后(订阅的资源为device,事件为activate),当设备首次接入物联网平台并激活时,平台会向应用服务器推送通知消息。 注意事项 应用服务器收到推送消息时,请务必返回响应码。 URI 请求方法 POST URI 由应用服务器订阅设备激活通知中的
使用Postman调测(联通用户专用) 非联通用户请查看设备接入服务。 调用API接口前建议完成Profile文件和编解码插件的开发。尽管接口的调用不依赖于Profile文件和编解码插件,但是由于profile文件定义了设备数据的字段,编解码插件是上报数据和下发命令时的必要条件,因此为了使得调用接口前的业务都正常
修改设备命令 接口说明 应用服务器向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行,此时应用服务器可调用此接口修改该命令的状态信息。仅能修改还处于PENDING状态的命令,且当前仅支持把命令状态修改为CANCELED状态,即撤销命令的执行。
订阅平台业务数据 接口说明 应用服务器可调用此接口在物联网平台订阅设备相关的业务信息,当设备的业务信息发生变化时(如设备注册、设备数据上报、设备状态变更等),平台会向应用服务器发送通知消息。 URI 请求方法 POST URI /iocm/app/sub/v1.2.0/subscriptions
创建设备组 接口说明 应用服务器可调用此接口在物联网平台上创建设备组,并把设备归类到不同的设备组内,进行分组管理。在对设备进行某些操作时(如升级设备软固件、批量下发命令等),可通过设备组来指定要进行操作的设备。 注意事项 一个设备只能归属一个设备组。 URI 请求方法 POST URI
创建订阅 接口说明 应用服务器可调用此接口订阅物联网平台资源的变化事件,当资源发生变化时(如设备激活,设备数据更新等),平台会向应用服务器发送通知消息。 URI 请求方法 POST URI /v5/iot/{project_id}/subscriptions 传输协议 HTTPS
修改设备组 典型场景 若因业务变更需要修改设备组的信息,如设备组名称、设备组的设备数量限制等,第三方应用可调用此接口修改指定设备组的信息。 接口功能 支持第三方应用在物联网平台修改指定设备组的信息。 接口描述 1 ModifyDeviceGroupOutDTO modifyDeviceGroup
刷新token 接口说明 应用服务器通过鉴权接口获取到的accessToken是有效时间的,在accessToken快过期时,应用服务器通过调用此接口,获取新的accessToken。 URI 请求方法 POST URI /iocm/app/sec/v1.1.0/refreshToken
创建设备命令撤销任务 接口说明 应用服务器向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行(PENDING状态),此时应用服务器可调用此接口撤销指定设备的所有未下发的命令,对于已下发成功的命令不可撤销。 URI 请求方法 POST URI /
Json组件使用说明 该组件为Agent Lite提供给开发者的工具组件,如果开发者无法进行Json格式的编码和解码,则可以使用该组件进行编码和解码。主要用于上报数据组装与下发命令解析。 1. Json编码 使用Json组件进行编码的流程。 创建Json编码对象。 1 HW_JSONOBJ
批量删除订阅 典型场景 第三方应用若不再需要接收物联网平台推送的订阅通知消息,或者不再需要接收某类订阅通知消息,可调用此接口批量删除订阅配置,取消订阅。 接口功能 支持第三方应用在物联网平台批量删除订阅配置,可删除全部订阅,或删除指定订阅类型的所有订阅,或删除指定回调URL地址的所有订阅
删除设备组成员 典型场景 若设备组中的一个或多个设备不再归属于该设备组,第三方应用可调用此接口从设备组删除设备成员。 接口功能 支持第三方应用在物联网平台从指定设备组删除设备。 接口描述 1 void deleteDevicesFromGroup(DeviceGroupWithDeviceListDTO
修改设备命令 典型场景 第三方应用向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行,此时第三方应用可调用此接口修改该命令的状态信息。当前仅支持把命令状态修改为CANCELED状态,即撤销命令的执行。 接口功能 支持第三方应用修改指定命令的状态信息