检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建设备接入实例 查询实例列表 查询实例详情 修改实例信息 删除实例 修改实例规格信息 修改实例计费模式 添加实例标签 删除实例标签 父主题: API
删除设备隧道 功能介绍 用户可通过该接口删除某个设备隧道。删除后该通道不存在,无法再次连接。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/tunnels/{tunnel_id}
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数
约束与限制 API的演进会保持前向兼容性,若接口升级了版本,其旧版本接口可以继续使用,但功能不再做增强,新增功能仅在新版本接口中提供。 应用在接收处理物联网平台发送的响应消息和推送消息时,需要兼容或忽略消息中的新增参数,不能因为消息中的新增参数导致应用的处理异常。 调用API的其他使用限制,请参见物联网平台的使用限制。
功能介绍 应用服务器可调用此接口在物联网平台创建一个设备,仅在创建后设备才可以接入物联网平台。 该接口支持使用gateway_id参数指定在父设备下创建一个子设备,并且支持多级子设备,当前最大支持二级子设备。 该接口同时还支持对设备进行初始配置,接口会读取创建设备请求参数prod
查询指定消息id的消息 功能介绍 应用服务器可调用此接口查询平台下发给设备的指定消息id的消息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/devices/{device_id}/messages/{message_id} 表1 路径参数
创建批量任务 功能介绍 应用服务器可调用此接口为创建批量处理任务,对多个设备进行批量操作。当前支持批量软固件升级、批量创建设备、批量修改设备、批量删除设备、批量冻结设备、批量解冻设备、批量创建命令、批量创建消息任务。 调用方法 请参见如何调用API。 URI POST /v5/iot/
冻结设备 功能介绍 应用服务器可调用此接口冻结设备,设备冻结后不能再连接上线,可以通过解冻设备接口解除设备冻结。注意,当前仅支持冻结与平台直连的设备。该接口仅支持冻结单个设备,如需批量冻结设备,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI POST /v5/iot
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。该接口仅支持删除单个设备,如需批量删除设备,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI DELETE /v5/i
备)。 注意:iot_前缀的为系统预留标签,用户不能使用;一个资源最多只能打10个标签。 绑定标签 解绑标签 按标签查询资源 父主题: API
批量任务 批量任务场景下,用户通过调用此目录接口实现任务文件管理功能。 - 当前支持批量创建设备任务、批量删除设备任务、批量冻结设备任务、批量解冻设备任务的文件管理。 - 当前单用户管理的文件数量最大为10,超过则无法上传新的文件。 - 当前文件最大存储时间为1小时,超过1小时文件会被平台自动老化。
设备代理 创建设备代理 查询设备代理列表 查询设备代理详情 修改设备代理 删除设备代理 父主题: API
应用服务器在调用物联网平台的创建规则触发条件(Resource:device.status,Event:update)、创建规则动作、修改规则触发条件接口配置并激活规则后,当物联网平台中的设备状态发生变更时,物联网平台会向应用服务器推送通知消息。 URI POST /由应用服务器创建设备状态变更通知规则的转发目标决定
设备影子用于存储设备上报的属性和应用程序期望的设备属性 - 无论该设备是否在线,都可以通过该影子获取和设置设备的状态 查询设备影子数据 配置设备影子预期数据 父主题: API
或特征,产品管理为应用服务器提供对物联网平台中产品模型的操作管理功能。 创建产品 查询产品列表 查询产品 修改产品 删除产品 父主题: API
入物联网平台并激活,则平台会删除该设备的注册信息。若设置为“0”,则表示设备验证码不会失效(建议填写为“0”)。注意:只有注册设备接口或者修改设备接口修改timeout时返回该参数。 最小值:0 最大值:2147483647 缺省值:0 表5 TagV5DTO 参数 是否必选 参数类型
查询设备 修改设备 删除设备 重置设备密钥 冻结设备 解冻设备 重置设备指纹 灵活搜索设备列表 查询指定设备加入的设备组列表 父主题: API
应用服务器可调用此接口停止批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade。如果task_id对应任务已经完成(成功、失败、部分成功,已经停止)或正在停止中,则不可以调用该接口。如果请求Body为{},则调用该接口后会停止所有正在
编解码函数管理 提供编解码函数管理功能。 创建编解码函数 查询编解码函数 删除编解码函数 父主题: API
更新CA证书 功能介绍 应用服务器可调用此接口在物联网平台上更新CA证书。仅标准版实例、企业版实例支持该接口调用,基础版不支持。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/certificates/{certificate_id}