检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建产品接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头
预调配模板管理 创建预调配模板 查询预调配模板列表 删除预调配模板 查询预调配模板详情 更新指定id的预调配模板信息 父主题: API
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token是服务端生成的一串字符串
创建网桥 功能介绍 应用服务器可调用此接口在物联网平台创建一个网桥,仅在创建后的网桥才可以接入物联网平台。 一个实例最多支持20个网桥。 仅标准版实例、企业版实例支持该接口调用,基础版不支持。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id
下发广播消息 功能介绍 应用服务器可调用此接口向订阅了指定Topic的所有在线设备发布广播消息。应用将广播消息下发给平台后,平台会先返回应用响应结果,再将消息广播给设备。 注意: 此接口只适用于使用MQTT协议接入的设备。 调用方法 请参见如何调用API。 URI POST /v5
删除批量任务 功能介绍 应用服务器可调用此接口删除物联网平台中已经完成(状态为成功,失败,部分成功,已停止)的批量任务。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/batchtasks/{task_id} 表1 路径参数 参数
删除实例 功能介绍 删除设备接入实例。约束:此接口仅支持删除按需计费的实例。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/iotda-instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述
重试批量任务 功能介绍 应用服务器可调用此接口重试批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade。如果task_id对应任务已经成功、停止、正在停止、等待中或初始化中,则不可以调用该接口。如果请求Body为{},则调用该接口后会重新执行所有状态为失败
解绑标签 功能介绍 应用服务器可调用此接口为指定资源解绑标签。当前支持标签的资源有Device(设备)。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/tags/unbind-resource 表1 路径参数 参数 是否必选 参数类型
查询规则 功能介绍 应用服务器可调用此接口查询物联网平台中指定规则的配置信息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/rules/{rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
删除网桥 功能介绍 应用服务器可调用此接口在物联网平台上删除指定网桥。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/bridges/{bridge_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
数据流转规则管理 资源空间是物联网平台中各资源的顶层概念,包括设备、产品、规则等各类资源都从属于资源空间,通过资源空间,实现一个账号下各类资源的逻辑隔离。 创建规则触发条件 查询规则条件列表 查询规则条件 修改规则触发条件 删除规则触发条件 创建规则动作 查询规则动作列表 查询规则动作
重置网桥密钥 功能介绍 应用服务器可调用此接口在物联网平台上重置网桥密钥。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/bridges/{bridge_id}/reset-secret 表1 路径参数 参数 是否必选 参数类型 描述
停止批量任务 功能介绍 应用服务器可调用此接口停止批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade。如果task_id对应任务已经完成(成功、失败、部分成功,已经停止)或正在停止中,则不可以调用该接口。如果请求Body为{},则调用该接口后会停止所有正在执行中
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。该接口仅支持删除单个设备,如需批量删除设备,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI DELETE /v5/iot
创建批量任务 功能介绍 应用服务器可调用此接口为创建批量处理任务,对多个设备进行批量操作。当前支持批量软固件升级、批量创建设备、批量修改设备、批量删除设备、批量冻结设备、批量解冻设备、批量创建命令、批量创建消息任务。 调用方法 请参见如何调用API。 URI POST /v5/iot
修改规则 功能介绍 应用服务器可调用此接口修改物联网平台中指定规则的配置。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/rules/{rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
冻结设备 功能介绍 应用服务器可调用此接口冻结设备,设备冻结后不能再连接上线,可以通过解冻设备接口解除设备冻结。注意,当前仅支持冻结与平台直连的设备。该接口仅支持冻结单个设备,如需批量冻结设备,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI POST /v5/iot
修改设备 功能介绍 应用服务器可调用此接口修改物联网平台中指定设备的基本信息。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询实例详情 功能介绍 查询设备接入实例详情。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/iotda-instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String