检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除单个订阅 接口说明 应用服务器若不再需要接收物联网平台推送的某个订阅通知消息时,可调用此接口删除指定的订阅配置,取消订阅。 URI 请求方法 DELETE URI /iocm/app/sub/v1.2.0/subscriptions/{subscriptionId} 传输协议
接口说明 应用服务器在物联网平台订阅了设备命令响应通知后(订阅的通知类型为commandRsp),当平台向设备下发命令,并收到设备返回的命令响应消息(如命令执行成功或者执行失败,设备要向平台返回指定内容响应)时,平台会向应用服务器推送通知消息。 仅适用于使用MQTT协议接入的设备,例如集成了AgentLite
设备Profile文件中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。 物联网平台不对设备命令进行缓存而是直接下发命令,设备不在线时命令下发失败。下发命令的具体格式需要应用服务器与设备自定义,物联网平台在接口中直接进行封装,透传。
可选 String query 设备组所属的应用ID,当创建授权应用下的设备组成员时才需要填写。 pageNo 可选 Integer query 分页查询参数,查询结果分页显示时指定要查看的页信息,默认值0,查询第一页,取值范围为大于等于0的整数。 pageSize 可选 Integer(1000)
若设备处于离线或异常状态时,应用服务器无法通过命令下发的方式向设备下发配置。此时可把要下发的配置设置到设备影子,当设备重新上线时,设备影子会把配置下发给设备。应用服务器可调用此接口查看设备影子上的设备配置信息及最新的设备上报数据信息。 注意事项 当前仅使用LWM2M协议的设备支持设备影子功能
批量删除订阅 接口说明 应用服务器若不再需要接收物联网平台推送的订阅通知消息,或者不再需要接收某类订阅通知消息,可调用此接口批量删除订阅配置,取消订阅,可删除全部订阅,或删除指定订阅类型的所有订阅,或删除指定回调URL地址的所有订阅。 URI 请求方法 DELETE URI /iocm/app/sub/v1
安全认证。在物联网平台的使用中,可用于物联网平台向应用服务器采用HTTPS协议推送数据时,物联网平台认证应用服务器的合法性。本文以Windows环境为例,介绍通过Openssl工具制作调测证书的方法,生成的证书为PEM编码格式的证书,后缀为.cer。 常见的证书存储格式如下表所示。
设备响应命令 接口说明 设备对物联网平台控制命令的应答。 应用服务器要需要调用“订阅平台业务数据”API订阅“commandRsp”类型的通知后,才能接收到设备对控制命令的应答。 Topic Topic /huawei/v1/devices/{deviceId}/data/{codecMode}
serviceId 必选 String(1-64) body 命令对应的服务ID,要与profile中定义的serviceId保持一致。 method 必选 String(1-128) body 服务下具体的命令名称,要与profile中定义的命令名保持一致。 paras 可选 ObjectNode
删除指定版本包 接口说明 对于不需要继续使用和保留的设备版本包,应用服务器可调用此接口在物联网平台上删除指定的版本包,可根据版本包ID删除指定的版本包文件,在调用该接口前需要通过“查询版本包列表”接口查询获得要删除的版本包ID。 URI 请求方法 DELETE URI /iodm/northbound/v1
DIS服务对应的通道名称,和通道ID参数中至少一个不为空,和通道ID参数都存在时,以通道ID参数值为准。通过调用DIS服务 查询通道列表接口获取。 stream_id 可选 String(256) DIS服务对应的通道ID,和通道名称参数中至少一个不为空,和通道名称参数都存在时,以本参数值为准。通过调用DIS服务
header 访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。 Authorization 必选 String header 访问物联网平台的认证信息,值为“Bearer {accessToken}”,其中{accessToken}为调用鉴权接口返回的accessToken。
查询批量任务的子任务信息 接口说明 应用服务器通过“创建批量任务”接口创建了设备的批量操作任务后,可调用此接口查询该批量任务中子任务的详情信息,如任务的执行状态、任务内容等。 URI 请求方法 GET URI /iocm/app/batchtask/v1.1.0/taskDetails
网关ID,用于标识一个网关设备。当设备是直连设备时,gatewayId与设备的deviceId一致。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。 appId 可选 String query 设备所属的应用ID,当查询授权应用下设备的服务能力时才需要填写。 deviceId
Profile(即产品模型)是用来描述一款产品中的设备“是什么”、“能做什么”以及“如何控制该设备”的文件。在物联网平台集成对接中需要先创建Profile,因为Profile里面定义了设备上报的数据和应用服务器下发的命令包含了哪些字段。定义Profile,即在物联网平台构建一款设备的抽象模型,使平台理解该
分页查询参数,查询结果分页显示时每页显示的记录数,默认1,最大值2000,建议根据设备上报数据的平均大小来设置,保证单次查询返回的包大小不超过16Mb,同时根据单次查询返回的包大小以及网络带宽设置合理的超时时间。 startTime 可选 String query 查询产生时间在startTime之后的历史数据
鉴权 接口说明 应用服务器首次访问物联网平台的开放API时,需调用此接口完成认证鉴权,获取accessToken。 注意事项 鉴权接口是调用其他API的前提,除了调用鉴权接口,其他接口调用都需要在request header中携带参数app_key和Authorization。a
String 版本包适用的设备类型。 model String 版本包适用的设备型号。 manufacturerName String 版本包适用的设备厂商名称。 protocolType String 版本包适用的设备协议类型 description String 版本包的描述信息。 date
timeoutCnt Integer 超时的任务数。 expiredCnt Integer 未执行的失效任务数。 completeCnt Integer 完成的任务数,完成的任务数=成功的任务数+失败的任务数+超时的任务数。 successRate Integer 任务成功率,单位
修改设备信息 接口说明 应用服务器在物联网平台注册设备后,若设备的基本信息发生变更,可调用此接口在物联网平台修改设备的基本信息,包括设备类型、设备模型、厂商信息、接入协议等。 URI 请求方法 PUT URI /iocm/app/dm/v1.4.0/devices/{deviceId}