检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
设备信息变化通知 典型场景 第三方应用在物联网平台订阅了设备信息变化通知后(订阅的通知类型为deviceInfoChanged),当设备的配置或状态信息(如设备厂商信息、位置信息、版本信息、在线状态信息等)发生变化时,平台会向第三方应用推送通知消息。 接口功能 支持物联网平台向订
设备命令下发 接口说明 设备Profile文件中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。 物联网平台不对设备命令进行缓存而是直接下发命令,设备不在线时命令下发失败。下发命令的具体格式需要应用服务器与设
删除设备 接口说明 已在物联网平台注册的设备,若不再需要接入平台时,应用服务器可调用此接口在物联网平台删除设备,使设备无法再接入平台。后续设备若需要再次接入平台,则需重新注册设备。 URI 请求方法 DELETE URI /iocm/app/dm/v1.4.0/devices/{deviceId}
批量删除订阅 接口说明 应用服务器若不再需要接收物联网平台推送的订阅通知消息,或者不再需要接收某类订阅通知消息,可调用此接口批量删除订阅配置,取消订阅,可删除全部订阅,或删除指定订阅类型的所有订阅,或删除指定回调URL地址的所有订阅。 URI 请求方法 DELETE URI /iocm/app/sub/v1
修改设备命令 接口说明 应用服务器向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行,此时应用服务器可调用此接口修改该命令的状态信息。仅能修改还处于PENDING状态的命令,且当前仅支持把命令状态修改为CANCELED状态,即撤销命令的执行。
创建订阅 接口说明 应用服务器可调用此接口订阅物联网平台资源的变化事件,当资源发生变化时(如设备激活,设备数据更新等),平台会向应用服务器发送通知消息。 URI 请求方法 POST URI /v5/iot/{project_id}/subscriptions 传输协议 HTTPS
查询设备影子历史数据 接口说明 应用服务器通过“修改设备影子”接口修改设备影子的配置时,物联网平台会保存修改记录。当应用服务器需要查看设备影子的历史配置记录时,可调用此接口查询获取。 URI 请求方法 GET URI /iocm/app/shadow/v1.5.0/deviceDesiredHistory
设备服务调用 典型场景 设备Profile文件中定义了物联网平台可向设备下发的命令,第三方应用可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。 物联网平台不对设备命令进行缓存而是直接下发命令,设备不在线时命令下发失败。下发命令的具体格式需要第三方应用与设
创建批量任务 接口说明 应用服务器若需要对多个设备进行批量操作时,可调用此接口创建设备的批量操作任务,当前仅支持给批量设备下发缓存命令。 URI 请求方法 POST URI /iocm/app/batchtask/v1.1.0/tasks 传输协议 HTTPS 请求参数 参数 必选/可选
创建设备命令撤销任务 接口说明 应用服务器向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行(PENDING状态),此时应用服务器可调用此接口撤销指定设备的所有未下发的命令,对于已下发成功的命令不可撤销。 URI 请求方法 POST URI /iocm/app/cmd/v1
鉴权 典型场景 第三方应用首次访问物联网平台的开放API时,需调用此接口完成接入认证;第三方应用在物联网平台的认证过期后,需调用此接口重新进行认证,才能继续访问物联网平台的开放API。 接口功能 支持第三方应用在首次访问物联网平台的开放API之前,完成在物联网平台的接入认证。 注意事项
查询设备影子 接口说明 若设备处于离线或异常状态时,应用服务器无法通过命令下发的方式向设备下发配置。此时可把要下发的配置设置到设备影子,当设备重新上线时,设备影子会把配置下发给设备。应用服务器可调用此接口查看设备影子上的设备配置信息及最新的设备上报数据信息。 注意事项 当前仅使用
刷新设备密钥 接口说明 已在物联网平台注册的设备,若设备的唯一标识码发生变更(如更换设备等场景),应用服务器需要调用此接口在物联网平台更新设备的唯一标识,并重新绑定设备。 注意事项 仅当设备处于离线状态时,才能进行刷新设备密钥操作。 URI 请求方法 PUT URI /iocm/app/reg/v1
订阅平台管理数据 典型场景 第三方应用可向物联网平台订阅设备相关的管理数据,当物联网平台中设备进行版本升级等相关操作时,平台会向第三方应用发送通知消息,知会其具体的操作状态或操作结果信息。第三方应用可以调用此接口向物联网平台订阅不同类型的设备升级操作通知。 接口功能 支持第三方应
查询指定版本包 接口说明 在进行设备版本升级前,应用服务器可调用此接口在物联网平台查询某个版本升级包的信息,确保设备要升级的版本包已上传到平台,可根据版本包ID查询指定版本包信息,在调用该接口前需要通过“查询版本包列表”接口查询获得版本包ID。 URI 请求方法 GET URI /iodm/northbound/v1
设备激活通知 接口说明 应用服务器在物联网平台订阅了设备激活通知后(订阅的资源为device,事件为activate),当设备首次接入物联网平台并激活时,平台会向应用服务器推送通知消息。 注意事项 应用服务器收到推送消息时,请务必返回响应码。 URI 请求方法 POST URI
修改设备命令 典型场景 第三方应用向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行,此时第三方应用可调用此接口修改该命令的状态信息。当前仅支持把命令状态修改为CANCELED状态,即撤销命令的执行。 接口功能 支持第三方应用修改指定命令的状
订阅平台业务数据 接口说明 应用服务器可调用此接口在物联网平台订阅设备相关的业务信息,当设备的业务信息发生变化时(如设备注册、设备数据上报、设备状态变更等),平台会向应用服务器发送通知消息。 URI 请求方法 POST URI /iocm/app/sub/v1.2.0/subscriptions
创建设备组 接口说明 应用服务器可调用此接口在物联网平台上创建设备组,并把设备归类到不同的设备组内,进行分组管理。在对设备进行某些操作时(如升级设备软固件、批量下发命令等),可通过设备组来指定要进行操作的设备。 注意事项 一个设备只能归属一个设备组。 URI 请求方法 POST URI
返回结果 请求发送以后,您会收到响应,包含:状态码、响应消息头和响应消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,物联网平台返回的状态码如下所示。 对于鉴权接口,如果调用后返回状态码为“200”,则表示请求成功。 状态码 编码 状态码说明 200