更新时间:2022-02-24 GMT+08:00

订阅平台管理数据

典型场景

应用服务器可调用此接口向物联网平台订阅设备相关的管理数据,当物联网平台中设备进行版本升级等相关操作时,平台会向应用服务器发送通知消息,知会其具体的操作状态或操作结果信息。

接口功能

支持应用服务器向物联网平台订阅设备的升级操作信息,当设备进行版本升级等相关操作时,平台会向应用服务器发送通知消息。

接口原型

请求方法

POST

请求地址

https://server:port/iodm/app/sub/v1.1.0/subscribe

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。

Authorization

必选

String

header

访问物联网平台的认证信息,值为“Bearer {accessToken}”,其中{accessToken}为调用鉴权接口返回的accessToken。

notifyType

必选

String

body

通知类型。

  • swUpgradeStateChangeNotify(软件升级状态变更通知,订阅后推送软件升级状态变更通知)
  • swUpgradeResultNotify(软件升级结果通知,订阅后推送软件升级结果通知)
  • fwUpgradeStateChangeNotify(固件升级状态变更通知,订阅后推送固件升级状态变更通知)
  • fwUpgradeResultNotify(固件升级结果通知,订阅后推送固件升级结果通知)

callbackUrl

必选

String

body

订阅的回调地址,用于接收对应类型的通知消息。

可使用HTTPS或HTTP回调地址,建议使用HTTPS。回调地址支持IP地址或域名格式,同时回调地址中必须指定回调地址的端口。例如:https://XXX.XXX.XXX.XXX:443/callbackurltest。

响应参数

Status Code: 200 OK

请求示例

Method: POST
request: https://server:port/iodm/app/sub/v1.1.0/subscribe
Header:
app_key: ******
Authorization: Bearer *****
Content-Type: application/json
Body:
{
  "notifyType": "swUpgradeStateChangeNotify",
  "callbackUrl": "http://******"
}

响应示例

response:
Status Code: 200 OK

错误码

Http状态码

错误码

错误描述

说明

400

100222

Internal server error.

回调地址非法。

处理建议:请检查请求体中的回调地址是否有误。

400

100228

The application input is invalid.

应用输入无效。

处理建议:请参考请求参数说明检查接口请求中的参数是否有误。

403

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

403

1010009

app throttle exceed.

应用调用接口过于频繁,超过流控值(默认值是100次/60s)。

处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。

403

1010005

App_key or access_token is invalid.

错误的token信息。

处理建议:请检查接口请求中所携带的accessToken是否有误。

500

100229

Get AppKey from header failed.

从消息头获取AppKey失败。

500

100244

register out route fail.

注册路由失败。

处理建议:联系物联网平台维护人员。