检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 参数 说明 URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 承载RES
删除单个订阅 接口说明 应用服务器若不再需要接收物联网平台推送的某个订阅通知消息时,可调用此接口删除指定的订阅配置,取消订阅。 URI 请求方法 DELETE URI /iocm/app/sub/v1.2.0/subscriptions/{subscriptionId} 传输协议
创建设备组 接口说明 应用服务器可调用此接口在物联网平台上创建设备组,并把设备归类到不同的设备组内,进行分组管理。在对设备进行某些操作时(如升级设备软固件、批量下发命令等),可通过设备组来指定要进行操作的设备。 注意事项 一个设备只能归属一个设备组。 URI 请求方法 POST URI
查询设备历史数据 典型场景 在日常运行中,物联网平台会收到并保存设备上报业务数据(默认保留时间为7天),第三方应用若需要查看某个设备上报到平台的历史数据,可调用此接口查询获取。 接口功能 支持第三方应用根据设备ID,查询指定设备上报到物联网平台的历史数据。 接口描述 1 def
查询单个订阅 接口说明 应用服务器可在物联网平台上创建多个订阅,以订阅不同类型的设备变更通知。应用服务器若需要查看某个订阅的配置信息,可调用此接口进行查询。 URI 请求方法 GET URI /iocm/app/sub/v1.2.0/subscriptions/{subscriptionId}
查询设备影子历史数据 接口说明 应用服务器通过“修改设备影子”接口修改设备影子的配置时,物联网平台会保存修改记录。当应用服务器需要查看设备影子的历史配置记录时,可调用此接口查询获取。 URI 请求方法 GET URI /iocm/app/shadow/v1.5.0/deviceDesiredHistory
创建批量任务 接口说明 应用服务器若需要对多个设备进行批量操作时,可调用此接口创建设备的批量操作任务,当前仅支持给批量设备下发缓存命令。 URI 请求方法 POST URI /iocm/app/batchtask/v1.1.0/tasks 传输协议 HTTPS 请求参数 参数 必选/可选
删除设备组成员 典型场景 若设备组中的一个或多个设备不再归属于该设备组,第三方应用可调用此接口从设备组删除设备成员。 接口功能 支持第三方应用在物联网平台从指定设备组删除设备。 接口描述 1 void deleteDevicesFromGroup(DeviceGroupWithDeviceListDTO
订阅平台管理数据 接口说明 应用服务器可调用此接口向物联网平台订阅设备相关的管理数据,当设备进行版本升级等相关操作时,平台会向应用服务器发送通知消息,知会其具体的操作状态或操作结果信息。 URI 请求方法 POST URI /iodm/app/sub/v1.1.0/subscribe
查询设备激活状态 典型场景 第三方应用通过“注册设备”接口在物联网平台注册设备后,在设备首次接入平台之前,设备的激活状态为false;当设备首次接入平台后,设备的激活状态为true(无论设备接入后是处于在线、离线或异常状态)。第三方应用可调用此接口查询设备在物联网平台的激活状态,确定设备是否已接入平台。
增加设备组成员 接口说明 若需要把新增的设备或已有设备增加到某个设备组中,应用服务器可调用此接口向指定设备组添加设备成员。在向设备组添加设备前,建议通过“查询指定设备组”接口查询该设备组的当前设备数量及最大设备数量限制,确保设备组中还有足够的可添加成员数量。 注意事项 一个设备只能归属一个设备组。
删除设备组 典型场景 若因分组变更,第三方应用不再需要使用某个设备组,且不想在物联网平台上继续保存该设备组信息时,可调用此接口在物联网平台删除指定设备组。 接口功能 支持第三方应用在物联网平台根据设备组ID删除指定设备组。 接口描述 1 def deleteDeviceGroup(self
查询批量任务的子任务信息 接口说明 应用服务器通过“创建批量任务”接口创建了设备的批量操作任务后,可调用此接口查询该批量任务中子任务的详情信息,如任务的执行状态、任务内容等。 URI 请求方法 GET URI /iocm/app/batchtask/v1.1.0/taskDetails
创建设备命令撤销任务 典型场景 第三方应用向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行(DEFAULT状态),此时第三方应用可调用此接口撤销指定设备的所有未下发的命令,对于已下发成功的命令不可撤销。 接口功能 支持第三方应用创建设备命令
查询设备历史数据 典型场景 在日常运行中,物联网平台会收到并保存设备上报业务数据(历史数据默认保留7天),第三方应用若需要查看某个设备上报到平台的历史数据,可调用此接口查询获取。 接口功能 支持第三方应用根据设备ID,查询指定设备上报到物联网平台的历史数据。 接口描述 1 Que
查询设备服务能力 接口说明 应用服务器若需要了解设备可上报哪些服务属性数据,以及设备支持下发哪些命令,可调用此接口在物联网平台查询设备的Profile文件中定义的设备服务能力信息。 URI 请求方法 GET URI /iocm/app/data/v1.1.0/deviceCapabilities
删除设备组成员 典型场景 若设备组中的一个或多个设备不再归属于该设备组,第三方应用可调用此接口从设备组删除设备成员。 接口功能 支持第三方应用在物联网平台从指定设备组删除设备。 接口描述 1 def deleteDevicesFromGroup(self, dgwdlDTO, accessAppId
增加设备组成员 典型场景 若需要把新增的设备或已有设备增加到某个设备组中,第三方应用可调用此接口向指定设备组添加设备成员。在向设备组添加设备前,建议通过“查询指定设备组”接口查询该设备组的当前设备数量及最大设备数量限制,确保设备组中还有足够的可添加成员数量。 接口功能 支持第三方应用在物联网平台向指定设备组添加设备。
查询设备影子历史数据 典型场景 第三方应用通过“修改设备影子”接口修改设备影子的配置时,物联网平台会保存修改记录。当第三方应用需要查看设备影子的历史配置记录时,可调用此接口查询获取。 接口功能 支持第三方应用根据设备ID,在物联网平台查询指定设备影子的历史配置数据。 接口描述 1
修改设备信息 接口说明 应用服务器在物联网平台注册设备后,若设备的基本信息发生变更,可调用此接口在物联网平台修改设备的基本信息,包括设备类型、设备模型、厂商信息、接入协议等。 URI 请求方法 PUT URI /iocm/app/dm/v1.4.0/devices/{deviceId}