检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 非联通用户请查看设备接入服务。 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括设备管理、数据采集、命令下发、设备升级等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表
鉴权 接口说明 应用服务器首次访问物联网平台的开放API时,需调用此接口完成认证鉴权,获取accessToken。 注意事项 鉴权接口是调用其他API的前提,除了调用鉴权接口,其他接口调用都需要在request header中携带参数app_key和Authorization。app_key
设备命令下发 接口说明 设备Profile文件中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。 物联网平台不对设备命令进行缓存而是直接下发命令,设备不在线时命令下发失败。下发命令的具体格式需要应用服务器与设备自定义
数据采集 物联网平台支持应用服务器查询设备的基本信息,同时还支持查看设备上报的历史数据,能按时、天,月等维度查看设备上报的历史数据。 查询单个设备信息 批量查询设备信息 查询设备历史数据 查询设备影子历史数据 查询设备服务能力 父主题: 应用侧API参考(联通用户专用)
设备升级 查询版本包列表 查询指定版本包 删除指定版本包 创建软件升级任务 创建固件升级任务 查询指定任务信息 查询指定任务的子任务详情 查询任务列表 父主题: 应用侧API参考(联通用户专用)
修改设备信息 接口说明 应用服务器在物联网平台注册设备后,若设备的基本信息发生变更,可调用此接口在物联网平台修改设备的基本信息,包括设备类型、设备模型、厂商信息、接入协议等。 URI 请求方法 PUT URI /iocm/app/dm/v1.4.0/devices/{deviceId
创建设备命令 接口说明 设备Profile文件中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。 物联网平台有两种命令下发机制: 立即下发:平台收到命令后立即下发给设备,保证实时性,不保证串行性。 缓存下发:平台收到命令后缓存起来
批量查询设备信息 接口说明 已在物联网平台注册的设备,应用服务器若需要根据条件查看多个设备的详细信息(如厂商、型号、版本、状态和服务属性等信息),可调用此接口在物联网平台查询获取。 URI 请求方法 GET URI /iocm/app/dm/v1.4.0/devices 传输协议
删除指定版本包 接口说明 对于不需要继续使用和保留的设备版本包,应用服务器可调用此接口在物联网平台上删除指定的版本包,可根据版本包ID删除指定的版本包文件,在调用该接口前需要通过“查询版本包列表”接口查询获得要删除的版本包ID。 URI 请求方法 DELETE URI /iodm/
设备管理 应用服务器向物联网平台添加设备,获取设备的ID和验证码,待设备完成接入物联网平台流程后,设备与应用服务器建立从属关系。 注册设备(验证码方式) 注册设备(密码方式) 刷新设备密钥 修改设备信息 删除设备 删除子设备 查询设备激活状态 修改设备影子 查询设备影子 注册LoRa
删除设备 接口说明 已在物联网平台注册的设备,若不再需要接入平台时,应用服务器可调用此接口在物联网平台删除设备,使设备无法再接入平台。后续设备若需要再次接入平台,则需重新注册设备。 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 请求参数 名称
刷新设备密钥 接口说明 已在物联网平台注册的设备,若设备的唯一标识码发生变更(如更换设备等场景),应用服务器需要调用此接口在物联网平台更新设备的唯一标识,并重新绑定设备。 注意事项 仅当设备处于离线状态时,才能进行刷新设备密钥操作。 URI 请求方法 PUT URI /iocm/app
修改设备影子 接口说明 物联网平台支持创建设备的“影子”。设备影子用于存储设备最新上报的服务属性数据,以及应用服务器对服务属性的配置(服务属性为设备Profile文件中定义的service属性)。若设备处于离线或异常状态时,应用服务器无法通过命令下发的方式向设备下发配置,此时可把要下发的配置设置到设备影子
查询设备影子 接口说明 若设备处于离线或异常状态时,应用服务器无法通过命令下发的方式向设备下发配置。此时可把要下发的配置设置到设备影子,当设备重新上线时,设备影子会把配置下发给设备。应用服务器可调用此接口查看设备影子上的设备配置信息及最新的设备上报数据信息。 注意事项 当前仅使用LWM2M
查询指定批量任务信息 接口说明 应用服务器通过“创建批量任务”接口创建了设备的批量操作任务后,可调用此接口查询该批量任务的信息,包括任务的当前状态、子任务(指批量任务中一个设备执行的任务)完成情况等。 URI 请求方法 GET URI /iocm/app/batchtask/v1.1.0
批量创建设备命令 应用服务器若需要向多个设备下发相同的设备命令时,可调用此接口向批量设备下发命令。 此功能通过创建批量任务接口向设备下发批量任务实现,“taskType”参数设置为“DeviceCmd”时,为向批量设备下发命令。 父主题: 命令下发
查询设备命令撤销任务 接口说明 应用服务器创建了设备命令撤销任务后,可调用此接口查询设备命令撤销任务的详细信息和执行状态,以了解撤销任务的执行情况,可指定条件查询单个或多个撤销任务。 URI 请求方法 GET URI /iocm/app/cmd/v1.4.0/deviceCommandCancelTasks
删除订阅 接口说明 应用服务器可调用此接口删除物联网平台中的指定订阅配置。 URI 请求方法 DELETE URI /v5/iot/{project_id}/subscriptions/{subscription_id} 传输协议 HTTPS 请求参数 名称 必选/可选 类型 位置