检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询版本包列表 接口说明 在进行设备版本升级前,应用服务器可调用此接口查询已经上传到物联网平台的版本升级包列表信息,确保设备要升级的版本包已上传到平台,可根据条件查询满足要求的版本包。 URI 请求方法 GET URI /iodm/northbound/v1.5.0/category
批量删除订阅 接口说明 应用服务器若不再需要接收物联网平台推送的订阅通知消息,或者不再需要接收某类订阅通知消息,可调用此接口批量删除订阅配置,取消订阅,可删除全部订阅,或删除指定订阅类型的所有订阅,或删除指定回调URL地址的所有订阅。 URI 请求方法 DELETE URI /iocm/app/sub/v1
注册设备(密码方式) 接口说明 在设备接入物联网平台前,应用服务器需要调用此接口在物联网平台注册设备,获取设备ID和密码。在设备接入物联网平台时携带设备ID和密码,完成设备的接入认证。 此注册设备接口适用于使用MQTT协议接入的设备。 URI 请求方法 POST URI /iocm/app/reg/v2
查询指定批量任务信息 接口说明 应用服务器通过“创建批量任务”接口创建了设备的批量操作任务后,可调用此接口查询该批量任务的信息,包括任务的当前状态、子任务(指批量任务中一个设备执行的任务)完成情况等。 URI 请求方法 GET URI /iocm/app/batchtask/v1
已在物联网平台注册的设备,若设备的唯一标识码发生变更(如更换设备等场景),应用服务器需要调用此接口在物联网平台更新设备的唯一标识,并重新绑定设备。 注意事项 仅当设备处于离线状态时,才能进行刷新设备密钥操作。 URI 请求方法 PUT URI /iocm/app/reg/v1.1.0/dev
接口说明 对于不需要继续使用和保留的设备版本包,应用服务器可调用此接口在物联网平台上删除指定的版本包,可根据版本包ID删除指定的版本包文件,在调用该接口前需要通过“查询版本包列表”接口查询获得要删除的版本包ID。 URI 请求方法 DELETE URI /iodm/northbound/v1
创建固件升级任务 接口说明 若需要对设备进行固件版本升级,应用服务器可调用此接口为多个设备创建固件升级任务,升级前请确保目标版本包已上传到物联网平台。 注意事项 仅支持对使用LWM2M协议接入的设备进行固件升级。 URI 请求方法 POST URI /iodm/northbound/v1
查询设备命令 接口说明 应用服务器向设备下发命令后,可调用此接口在物联网平台查询下发命令的状态及内容信息,以了解命令的执行情况,可查询指定时间段内本应用下的所有下发命令,或者指定设备的所有下发命令。 URI 请求方法 GET URI /iocm/app/cmd/v1.4.0/deviceCommands
查询任务列表 接口说明 应用服务器可调用此接口查询已创建的升级任务列表信息,以了解当前已有的升级任务信息及各个任务的执行情况,可根据条件查询满足要求的升级任务信息。 URI 请求方法 GET URI /iodm/northbound/v1.5.0/operations 传输协议 HTTPS
创建设备组 接口说明 应用服务器可调用此接口在物联网平台上创建设备组,并把设备归类到不同的设备组内,进行分组管理。在对设备进行某些操作时(如升级设备软固件、批量下发命令等),可通过设备组来指定要进行操作的设备。 注意事项 一个设备只能归属一个设备组。 URI 请求方法 POST URI
创建软件升级任务 接口说明 若需要对设备进行软件版本升级,应用服务器可调用此接口为多个设备创建软件升级任务,升级前请确保目标版本包已上传到物联网平台。 注意事项 仅支持对使用LWM2M协议接入的设备进行软件升级。 URI 请求方法 POST URI /iodm/northbound/v1
接口说明 在进行设备版本升级前,应用服务器可调用此接口在物联网平台查询某个版本升级包的信息,确保设备要升级的版本包已上传到平台,可根据版本包ID查询指定版本包信息,在调用该接口前需要通过“查询版本包列表”接口查询获得版本包ID。 URI 请求方法 GET URI /iodm/northbound/v1
查询单个设备信息 接口说明 已在物联网平台注册的设备,应用服务器若需要查看某个设备的详细信息(如厂商、型号、版本、状态和服务属性等信息),可调用此接口在物联网平台查询获取。 URI 请求方法 GET URI /iocm/app/dm/v1.4.0/devices/{deviceId}
批量查询设备信息 接口说明 已在物联网平台注册的设备,应用服务器若需要根据条件查看多个设备的详细信息(如厂商、型号、版本、状态和服务属性等信息),可调用此接口在物联网平台查询获取。 URI 请求方法 GET URI /iocm/app/dm/v1.4.0/devices 传输协议
return true; } }); 主机名校验方法应以安全为原则,不应该直接返回true。 业务接口调用方法 设置好NorthApiClient实例后才能调用其他业务接口。以如下几个接口为例说明如何调用业务接口。 关于哪些参数需要设置,请查看《应用侧JAVA SDK API参考》
鉴权 接口说明 应用服务器首次访问物联网平台的开放API时,需调用此接口完成认证鉴权,获取accessToken。 注意事项 鉴权接口是调用其他API的前提,除了调用鉴权接口,其他接口调用都需要在request header中携带参数app_key和Authorization。a
业务接口调用方法 设置好Constant.py后才能调用其他业务接口。所有业务接口的测试都在“invokeapiTest”中。以如下几个接口为例说明如何调用业务接口: 关于哪些参数需要设置,请查看《应用侧Python SDK API参考》对于可选参数,如果业务不需要,可以不设置。 配置日志
中涉及的每个设备的升级是一个子任务(即升级任务中涉及多少个设备,就有多少个子任务)。应用服务器可调用此接口查询某个升级任务中各个子任务的详细信息,以查看子任务的具体执行情况。 URI 请求方法 GET URI /iodm/northbound/v1.5.0/operations/
若需要把新增的设备或已有设备增加到某个设备组中,应用服务器可调用此接口向指定设备组添加设备成员。在向设备组添加设备前,建议通过“查询指定设备组”接口查询该设备组的当前设备数量及最大设备数量限制,确保设备组中还有足够的可添加成员数量。 注意事项 一个设备只能归属一个设备组。 URI 请求方法 POST URI /iocm/app/dm/v1
知应用服务器。 expireTime 可选 Integer(>=0) body 下发命令的有效时间,单位为秒,表示设备命令在创建后expireTime秒内有效,超过这个时间范围后命令将不再下发,如果未设置则默认为48小时(86400s*2)。 如果expireTime设置为0,则