检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
设备绑定 接口功能 设备第一次接入物联网平台时需要进行绑定操作,上层应用通过调用该接口传入设备序列号或者MAC地址以及设备信息来绑定到物联网平台。 在绑定前需要调用绑定配置接口设置物联网平台的IP与端口,对应参数配置为EN_IOTA_CFG_IOCM_ADDR和EN_IOTA_CFG_IOCM_PORT
登录参数配置 接口功能 在登录前配置登录所需要的参数。 接口描述 1 public static boolean setConfig(int key, String value); 接口所属类 LoginConfig 参数说明 字段 必选/可选 类型 描述 key 必选 int
调用订阅接口时,回调地址如何获取? 以业务应用订阅设备数据变化通知为例,订阅和推送的流程如下: 应用服务器通过调用物联网平台的订阅接口订阅设备数据变化通知(携带回调地址和通知类型),物联网平台将业务应用的回调地址和订阅的通知类型存储到订阅列表中以便向业务应用推送设备数据变化消息。
查询批量任务的子任务信息 接口说明 应用服务器通过“创建批量任务”接口创建了设备的批量操作任务后,可调用此接口查询该批量任务中子任务的详情信息,如任务的执行状态、任务内容等。 URI 请求方法 GET URI /iocm/app/batchtask/v1.1.0/taskDetails
刷新设备密钥 典型场景 已在物联网平台注册的设备,若设备的唯一标识码发生变更(如更换设备等场景),第三方应用需要调用此接口在物联网平台更新设备的唯一标识,并重新绑定设备。 仅当设备处于离线状态时,才能进行刷新设备密钥操作。 接口功能 支持第三方应用在物联网平台更新已注册设备的nodeId
鉴权 接口说明 应用服务器首次访问物联网平台的开放API时,需调用此接口完成认证鉴权,获取accessToken。 注意事项 鉴权接口是调用其他API的前提,除了调用鉴权接口,其他接口调用都需要在request header中携带参数app_key和Authorization。app_key
设备绑定 接口功能 设备第一次接入物联网平台时需要进行绑定操作,上层应用通过调用该接口传入设备序列号或者MAC地址以及设备信息来绑定到物联网平台。 在绑定前需要调用BindConfig.setConfig接口设置物联网平台的IP与端口。 设备绑定是指设备第一次接入物联网平台的过程,
查询订阅列表 接口说明 应用服务器可调用此接口查询物联网平台中的订阅配置信息列表。 URI 请求方法 GET URI /v5/iot/{project_id}/subscriptions 传输协议 HTTPS 请求参数 名称 必选/可选 类型 位置 说明 X-Auth-Token
查询设备服务能力 典型场景 第三方应用若需要了解设备可上报哪些服务属性数据,以及设备支持下发哪些命令,可调用此接口在物联网平台查询设备的Profile文件中定义的设备服务能力信息。 接口功能 支持第三方应用在物联网平台查询设备的服务属性、设备命令等服务能力信息。 接口描述 1 QueryDeviceCapabilitiesOutDTO
查询设备服务能力 典型场景 第三方应用若需要了解设备可上报哪些服务属性数据,以及设备支持下发哪些命令,可调用此接口在物联网平台查询设备的Profile文件中定义的设备服务能力信息。 接口功能 支持第三方应用在物联网平台查询设备的服务属性、设备命令等服务能力信息。 接口描述 1 def
查询设备命令撤销任务 典型场景 第三方应用创建了设备命令撤销任务后,可调用此接口查询设备命令撤销任务的详细信息和执行状态,以了解撤销任务的执行情况。 接口功能 支持第三方应用在物联网平台查询设备命令撤销任务信息和状态,可指定条件查询单个或多个撤销任务。 接口描述 1 def queryDeviceCmdCancelTask
设备登出 接口功能 断开与物联网平台的连接。 接口描述 1 public static boolean logout(); 接口所属类 LoginService 接口返回值 返回值 描述 true 成功。 false 失败。 此返回值是调用接口的同步返回结果,返回true只是说明接口调用成功
设备登录 接口功能 设备在第一次绑定后,或者在设备重启后需要进行登录的流程。 接口描述 1 public static boolean login(); 接口所属类 LoginService 接口返回值 返回值 描述 true 成功。 false 失败。 此返回值是调用接口的同步返回结果
查询设备命令撤销任务 典型场景 第三方应用创建了设备命令撤销任务后,可调用此接口查询设备命令撤销任务的详细信息和执行状态,以了解撤销任务的执行情况。 接口功能 支持第三方应用在物联网平台查询设备命令撤销任务信息和状态,可指定条件查询单个或多个撤销任务。 接口描述 1 QueryDeviceCmdCancelTaskOutDTO2
鉴权 典型场景 第三方应用首次访问物联网平台的开放API时,需调用此接口完成接入认证;第三方应用在物联网平台的认证过期后,需调用此接口重新进行认证,才能继续访问物联网平台的开放API。 接口功能 支持第三方应用在首次访问物联网平台的开放API之前,完成在物联网平台的接入认证。 注意事项
消息结构体说明 转发设备上报的属性 根据定义的产品模型,上报设备属性至平台。结构体描述如下: 表1 属性上报规则转发结构体 参数名称 类型 描述 device_id String 设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。 services services
查询指定升级任务结果 典型场景 在创建了设备软件升级任务或固件升级任务后,第三方应用可调用此接口查询某个升级任务详细信息,以查看升级任务的配置信息和执行情况等。 接口功能 支持第三方应用在物联网平台查询单个固件或软件升级任务的详细信息,包括升级任务的配置信息和执行情况等。 接口描述
查询指定升级任务结果 典型场景 在创建了设备软件升级任务或固件升级任务后,第三方应用可调用此接口查询某个升级任务详细信息,以查看升级任务的配置信息和执行情况等。 接口功能 支持第三方应用在物联网平台查询单个固件或软件升级任务的详细信息,包括升级任务的配置信息和执行情况等。 接口描述
设备状态变化结果通知 接口说明 应用服务器在物联网平台订阅设备状态变化通知事件后(资源为device.status,事件为update),当物联网平台中的设备状态发生变化时,平台会向应用服务器推送通知消息。 注意事项 应用服务器收到推送消息时,请务必返回响应码。 URI 请求方法
鉴权 典型场景 第三方应用首次访问物联网平台的开放API时,需调用此接口完成接入认证;第三方应用在物联网平台的认证过期后,需调用此接口重新进行认证,才能继续访问物联网平台的开放API。 接口功能 支持第三方应用在首次访问物联网平台的开放API之前,完成在物联网平台的接入认证。 注意事项