检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询设备所有隧道 功能介绍 用户可通过该接口查询某项目下的所有设备隧道,以实现对设备管理。应用服务器可通过此接口向平台查询设备隧道建立的情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET /v5/i
device_id 否 String 参数说明:设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。存在该参数时设备属性触发根据指定设备触发,该参数值和product_id不能同时为空。如果该参数和product_id同时存在时,以该参数值对应的设备进行条件过滤。 取值范围
发InfluxDB消息类型。(仅标准版和企业版支持) MYSQL_FORWARDING:转发MySQL消息类型。(仅标准版和企业版支持) FUNCTIONGRAPH_FORWARDING:转发FunctionGraph消息类型。(仅标准版和企业版支持) MRS_KAFKA_FOR
参数说明:标签键,标签的键可用字母(包含中文)、数字、空格和以下字符:下划线(_)点(.)冒号(:)等号(=)加号(+)中划线(-)以及@,首尾不能有空格字符。 value String 参数说明:标签值,可为空字符串和null,标签的值可用字母(包含中文)、数字、空格和以下字符:下划线(_)点(.)冒号
功能介绍 应用服务器可调用此接口修改已导入物联网平台的指定产品模型,包括产品模型的服务、属性、命令等。此接口仅修改了产品,未修改和安装插件,如果修改了产品中的service定义,且在平台中有对应的插件,请修改并重新安装插件。 调用方法 请参见如何调用API。 URI PUT /v5
发InfluxDB消息类型。(仅标准版和企业版支持) MYSQL_FORWARDING:转发MySQL消息类型。(仅标准版和企业版支持) FUNCTIONGRAPH_FORWARDING:转发FunctionGraph消息类型。(仅标准版和企业版支持) MRS_KAFKA_FOR
创建设备策略 功能介绍 应用服务器可调用此接口在物联网平台创建一个策略,该策略需要绑定到设备和产品下才能生效。 一个实例最多能创建50个设备策略。 仅标准版实例、企业版实例支持该接口调用,基础版不支持。 调用方法 请参见如何调用API。 URI POST /v5/iot/{pro
解冻设备 功能介绍 应用服务器可调用此接口解冻设备,解除冻结后,设备可以连接上线。该接口仅支持解冻单个设备,如需批量解冻设备,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/devices/{device_id}/unfreeze
参数说明:设备验证码的有效时间,单位:秒,默认值:0。若设备在有效时间内未接入物联网平台并激活,则平台会删除该设备的注册信息。若设置为“0”,则表示设备验证码不会失效(建议填写为“0”)。注意:只有注册设备接口或者修改设备接口修改timeout时返回该参数。 最小值:0 最大值:2147483647 缺省值:0
设备侧MQTT/MQTTS接口参考 使用前必读 通信方式概述 Topic定义 设备连接鉴权 设备命令 设备消息 设备属性 网关与子设备管理 软固件升级 文件上传/下载管理 设备时间同步 设备信息上报 设备日志收集 远程配置 设备隧道管理
设备侧HTTPS接口参考 使用https协议接入 API概览 设备鉴权 设备消息上报 设备属性上报
安全隧道WebSocket接口参考 使用安全隧道通信协议接入 建立安全隧道的WebSocket连接 安全隧道协议消息交互说明
删除产品 功能介绍 应用服务器可调用此接口删除已导入物联网平台的指定产品模型。此接口仅删除了产品,未删除关联的插件,在产品下存在设备时,该产品不允许删除。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/products/{product_id}
约束与限制 API的演进会保持前向兼容性,若接口升级了版本,其旧版本接口可以继续使用,但功能不再做增强,新增功能仅在新版本接口中提供。 应用在接收处理物联网平台发送的响应消息和推送消息时,需要兼容或忽略消息中的新增参数,不能因为消息中的新增参数导致应用的处理异常。 调用API的其他使用限制,请参见物联网平台的使用限制。
设备消息上报 接口说明 用于设备将自定义数据上报给平台,平台将设备上报的消息转发给应用服务器或华为云其他云服务上进行存储和处理。 URI 请求方法 POST URI /v5/devices/{device_id}/sys/messages/up 传输协议 HTTPS 请求参数 名称
下发广播消息 功能介绍 应用服务器可调用此接口向订阅了指定Topic的所有在线设备发布广播消息。应用将广播消息下发给平台后,平台会先返回应用响应结果,再将消息广播给设备。 注意: 此接口只适用于使用MQTT协议接入的设备。 调用方法 请参见如何调用API。 URI POST /v5/io
参数说明:标签键,标签的键可用字母(包含中文)、数字、空格和以下字符:下划线(_)点(.)冒号(:)等号(=)加号(+)中划线(-)以及@,首尾不能有空格字符。 value String 参数说明:标签值,可为空字符串和null,标签的值可用字母(包含中文)、数字、空格和以下字符:下划线(_)点(.)冒号
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建产品接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响
删除实例 功能介绍 删除设备接入实例。约束:此接口仅支持删除按需计费的实例。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/iotda-instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述
创建网桥 功能介绍 应用服务器可调用此接口在物联网平台创建一个网桥,仅在创建后的网桥才可以接入物联网平台。 一个实例最多支持20个网桥。 仅标准版实例、企业版实例支持该接口调用,基础版不支持。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/bridges