检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
定时刷新token 典型场景 第三方应用通过调用此接口,定期刷新accessToken,刷新周期为鉴权方法返回值中的expiresIn,以保证accessToken不过期。accessToken由SDK管理,调用其他业务接口,accessToken可以直接传入null。 接口功能
接收设备命令 接口功能 注册设备命令接收广播来接收处理平台下发的控制命令。 接口描述 1 DataTransService.TOPIC_COMMAND_RECEIVE; 返回结果 广播名称 广播参数 成员 描述 TOPIC_COMMAND_RECEIVE IotaMessage
鉴权 典型场景 第三方应用首次访问物联网平台的开放API时,需调用此接口完成接入认证;第三方应用在物联网平台的认证过期后,需调用此接口重新进行认证,才能继续访问物联网平台的开放API。 接口功能 支持第三方应用在首次访问物联网平台的开放API之前,完成在物联网平台的接入认证。 注意事项
构造请求 请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 参数 说明 URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 承载RES
设备服务能力增加通知 接口说明 应用服务器在物联网平台订阅了设备服务能力增加通知后(订阅的通知类型为deviceCapabilitiesAdded),在物联网平台上新增设备Profile文件时,平台会向应用服务器推送通知消息。 注意事项 应用收到推送消息,请务必返回响应码。 URI
设备服务能力删除通知 接口说明 应用服务器在物联网平台订阅了设备服务能力删除通知后(订阅的通知类型为deviceCapabilitiesDeleted),在物联网平台上删除设备Profile文件时,平台会向应用服务器推送通知消息。 注意事项 应用收到推送消息,请务必返回响应码。 URI
设备服务能力变化通知 接口说明 应用服务器在物联网平台订阅了设备服务能力变化通知后(订阅的通知类型为deviceCapabilitiesChanged),在物联网平台上设备Profile文件中的服务和属性被修改时,平台会向应用服务器推送通知消息。 注意事项 应用收到推送消息,请务必返回响应码。
设备影子(联通用户专用) 非联通用户请查看设备接入服务。 概述 物联网平台支持创建设备的“影子”。设备影子是一个JSON文件,用于存储设备的在线状态、设备最近一次上报的设备属性值、应用服务器期望下发的配置。每个设备有且只有一个设备影子,设备可以获取和设置设备影子以此来同步设备属性
设备登录 接口功能 设备在第一次绑定后,或者在设备重启后需要进行登录的流程。 接口描述 1 public static boolean login(); 接口所属类 LoginService 接口返回值 返回值 描述 true 成功。 false 失败。 此返回值是调用接口的同
接收设备命令 接口功能 注册设备命令接收广播来接收处理平台下发的控制命令。 接口描述 1 IOTA_TOPIC_SERVICE_COMMAND_RECEIVE/{deviceId}; 参数说明 枚举项 枚举值 类型 描述 EN_IOTA_DATATRANS_IE_RESULT 0
设备命令响应通知 接口说明 应用服务器在物联网平台订阅了设备命令响应通知后(订阅的通知类型为commandRsp),当平台向设备下发命令,并收到设备返回的命令响应消息(如命令执行成功或者执行失败,设备要向平台返回指定内容响应)时,平台会向应用服务器推送通知消息。 仅适用于使用MQ
删除指定版本包 接口说明 对于不需要继续使用和保留的设备版本包,应用服务器可调用此接口在物联网平台上删除指定的版本包,可根据版本包ID删除指定的版本包文件,在调用该接口前需要通过“查询版本包列表”接口查询获得要删除的版本包ID。 URI 请求方法 DELETE URI /iodm/northbound/v1
上报设备数据 接口功能 当直连设备(网关)有数据需要上报或者非直连设备上报数据到网关时,网关需要调用设备服务数据上报接口将数据上报到物联网平台。 上报设备数据接口的deviceId,requstId和serviceId由SDK组装为消息的header;servicePropert
删除设备 接口功能 当有新设备需要从网关移除时,通过调用设备删除接口将非直连设备从物联网平台删除。 接口描述 1 public static boolean rmvDevice(int cookie, String deviceId); 接口所属类 HubService 参数说明
设备消息确认通知 接口说明 应用服务器在物联网平台订阅了设备消息确认通知后(订阅的通知类型为messageConfirm),当平台向设备下发命令,并收到设备返回的命令确认消息(如命令已送达、已执行等)时,平台会向应用服务器推送通知消息。 仅适用于使用MQTT协议接入的设备,例如集成了AgentLite
更新设备状态 接口功能 通过该接口更新设备的状态信息,包括直连设备与所管理的非直连设备。设备离线、上线均可通过该接口刷新设备状态信息。 直连设备状态通过设备的登录状态进行管理,当直连设备连接断开则表示设备离线,当直连设备连接或重连成功,则表示设备上线,无需通过该接口进行刷新。故建
订阅平台管理数据 接口说明 应用服务器可调用此接口向物联网平台订阅设备相关的管理数据,当设备进行版本升级等相关操作时,平台会向应用服务器发送通知消息,知会其具体的操作状态或操作结果信息。 URI 请求方法 POST URI /iodm/app/sub/v1.1.0/subscribe
设备激活通知 接口说明 应用服务器在物联网平台订阅了设备激活通知后(订阅的资源为device,事件为activate),当设备首次接入物联网平台并激活时,平台会向应用服务器推送通知消息。 注意事项 应用服务器收到推送消息时,请务必返回响应码。 URI 请求方法 POST URI
订阅平台业务数据 接口说明 应用服务器可调用此接口在物联网平台订阅设备相关的业务信息,当设备的业务信息发生变化时(如设备注册、设备数据上报、设备状态变更等),平台会向应用服务器发送通知消息。 URI 请求方法 POST URI /iocm/app/sub/v1.2.0/subscriptions
删除设备组 接口说明 若因分组变更,应用服务器不再需要使用某个设备组,且不想在物联网平台上继续保存该设备组信息时,可调用此接口在物联网平台删除指定设备组。 URI 请求方法 DELETE URI /iocm/app/devgroup/v1.3.0/devGroups/{devGroupId}