检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成,并以调用物联网平台的查询产品和创建产品接口说明如何调用API,该API可用于获取用户的指定产品信息。 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ?
查询实例列表 功能介绍 用户可以调用此接口查询设备接入实例列表。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/iotda-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明
示例二:给指定设备下发消息 场景描述 本章节指导用户通过API给指定设备下发消息。API的调用方法参见如何调用API。 涉及接口 查询设备列表:确定待下发消息的设备。 下发设备消息:给指定设备下发消息。 查询指定消息id的消息:确认消息下发结果。 操作步骤 确定待下发消息的设备。
查询设备所有隧道 功能介绍 用户可通过该接口查询某项目下的所有设备隧道,以实现对设备管理。应用服务器可通过此接口向平台查询设备隧道建立的情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET /
查询设备隧道 功能介绍 用户可通过该接口查询某项目中的某个设备隧道,查看该设备隧道的信息与连接情况。应用服务器可调用此接口向平台查询设备隧道建立情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET
身份认证与访问控制 身份认证 用户访问IoTDA的所有接口都需要携带身份凭证,并进行身份的合法性校验。IoTDA不同的接入场景需要携带不同的身份凭证,主要有如下四种场景: IoTDA应用侧接口支持IAM Token认证和访问密钥(AK/SK)认证两种认证方式进行认证鉴权,关于Token
创建设备隧道 功能介绍 用户可以通过该接口创建隧道(WebSocket协议),应用服务器和设备可以通过该隧道进行数据传输。 该API接口在基础版不支持。 该API调用后平台会向对应的MQTT/MQTTS设备下发隧道地址及密钥,同时给应用服务器也返回隧道地址及密钥,设备可以通过该地址及密钥创建
示例一:使用模板文件批量创建设备 场景描述 本章节指导用户通过API批量创建设备。API的调用方法参见如何调用API。 物联网平台支持通过请求参数和模板文件两种方式批量创建设备。本节以模板文件的方式为例,介绍如何批量创建设备。 涉及接口 查询产品列表:确定待创建设备所属的产品。 上传批量任务文件
使用安全隧道通信协议接入 概述 物联网平台提供了安全隧道功能,通过使用安全隧道通信协议,建立应用端与设备端间的WebSocket通道,可以实现远程连接企业内部网的物联网平台设备,有效解决了无法直接从外部登录部署在企业内部的设备的问题场景。 当应用端与设备端都完成安全隧道的连接后,用户可以在应用端远程登录使用基于安全隧道建链的设备
设备命令下发 LwM2M对象资源 物联网平台向设备设备异步命令,物联网平台通过LwM2M的/19/1/0资源对象将命令打包到LwM2M write消息的payload里下发给设备。 Operation CoAP Method URI Success Failure Write PUT
设备侧获取平台的设备影子数据 功能介绍 用于设备向平台获取设备影子数据。用户可以通过应用服务器或物联网控制台配置设备影子预期数据,设备上线时订阅该topic,可以获取到平台设备影子数据,以此来同步设备属性期望值,从而完成设备属性值的修改。 简单交互逻辑介绍如下: ① 应用调用“配置设备影子预期数据
下载和上传插件 在线开发完成编解码插件后,可以将插件下载到本地。 下载编解码插件 访问设备接入服务,单击“管理控制台”进入设备接入控制台。选择您的实例,单击实例卡片进入。 单击左侧导航栏的“产品”,在产品列表中,找到对应的产品,单击产品进入产品界面。 单击“插件开发 > 图形化开发
下发设备消息 功能介绍 物联网平台可向设备下发消息,应用服务器可调用此接口向指定设备下发消息,以实现对设备的控制。应用将消息下发给平台后,平台返回应用响应结果,平台再将消息发送给设备。平台返回应用响应结果不一定是设备接收结果,建议用户应用通过订阅设备消息状态变更通知,订阅后平台会将设备接收结果推送给订阅的应用
停止计费 包年/包月资源 对于包年/包月计费模式的资源,例如包年/包月的设备接入实例,用户在购买时会一次性付费,服务将在到期后自动停止使用。 如果在计费周期内不再使用包年/包月资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户
离线开发插件 编解码插件实现二进制格式与JSON格式相互转换或JSON格式之间的转换,产品模型定义了该JSON格式的具体内容。因此,编解码插件开发前需要先编写设备的产品模型。 为了提高离线开发的集成效率,我们提供了编解码插件的编解码插件样例,建议您基于DEMO工程进行二次开发。 2023
计费模式概述 设备接入服务提供按需计费、包年/包月两种计费模式,以满足不同场景下的用户需求。 包年/包月:一种预付费模式,即先付费再使用,按照订单的购买周期进行结算。购买周期越长,享受的折扣越大。一般适用于设备需求量长期稳定的成熟业务。 按需计费:一种后付费模式,即先使用再付费,按照实际使用时长计费
创建自定义鉴权 功能介绍 应用服务器可调用此接口在物联网平台创建一个自定义鉴权。自定义鉴权是指用户可以通过函数服务自定义实现鉴权逻辑,以对接入平台的设备进行身份认证。 单个实例最大可配置10个自定义鉴权 仅标准版实例、企业版实例支持该接口调用,基础版不支持。 调用方法 请参见如何调用
应用快速接入 为了降低应用侧的开发难度、提升应用侧开发效率,物联网平台向应用侧开放了丰富的API。本文档以在线调试(即API Explorer)和本地调试(Postman)为例,模拟应用服务器以HTTPS协议为例接入物联网平台。 在线调试(推荐) API Explorer提供在线API
通过协议转换网关实现泛协议设备接入 场景说明 目前平台只支持MQTT/HTTP/LWM2M等标准协议接入,如果设备是其他协议(统称为第三方协议),怎么接入平台? 由于第三方协议设备不能直接接入平台,需要在平台外部完成协议转换。我们推荐使用网关来完成协议转换,将第三方协议转成MQTT
查询指定消息id的消息 功能介绍 应用服务器可调用此接口查询平台下发给设备的指定消息id的消息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/devices/{device_id}/messages/{message_id} 表1 路径参数