文档首页 > > API参考> 应用侧API参考(联通用户专用)> 订阅管理> 批量查询订阅

批量查询订阅

分享
更新时间: 2020/06/02 GMT+08:00

接口说明

应用服务器可在物联网平台上创建多个订阅,以订阅不同类型的设备变更通知。应用服务器若需要查看本应用下所有订阅配置,或者查看某种订阅类型下的所有订阅配置,可调用此接口进行查询。

URI

请求方法

GET

URI

/iocm/app/sub/v1.2.0/subscriptions

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

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

Authorization

必选

String

header

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

appId

可选

String(256)

query

订阅所属的应用ID,当查询授权应用下的订阅时才需要填写。

notifyType

可选

String(256)

query

通知类型,应用可以根据通知类型对消息分别进行处理。

  • deviceAdded(添加新设备,订阅后推送注册设备通知)
  • bindDevice(绑定设备,订阅后推送绑定设备通知)
  • deviceInfoChanged(设备信息变化,订阅后推送设备信息变化通知)
  • deviceDataChanged(设备数据变化,订阅后推送设备数据变化通知)
  • deviceDatasChanged(设备数据批量变化,订阅后推送批量设备数据变化通知)
  • deviceCapabilitiesChanged(设备服务能力变化,订阅后推送设备服务能力变化通知)
  • deviceCapabilitiesAdded(设备服务能力增加,订阅后推送设备服务能力增加通知)
  • deviceCapabilitiesDeleted(设备服务能力删除,订阅后推送设备服务能力删除通知)
  • deviceDeleted(删除设备,订阅后推送删除设备通知)
  • messageConfirm(消息确认,订阅后推送设备消息确认通知)
  • commandRsp(命令响应,订阅后推送设备命令响应通知)
  • ruleEvent(规则事件,订阅后推送规则事件通知)
  • deviceDesiredPropertiesModifyStatusChanged(设备影子状态变更,订阅后推送设备影子状态变更通知)
  • swUpgradeStateChangeNotify(软件升级状态变更通知)
  • swUpgradeResultNotify(软件升级结果通知)
  • fwUpgradeStateChangeNotify(固件升级状态变更通知)
  • fwUpgradeResultNotify(固件升级结果通知)

pageNo

可选

Integer

query

分页查询参数,查询结果分页显示时指定要查看的页信息,默认值0,查询第一页,取值范围为大于等于0的整数。

pageSize

可选

Integer

query

分页查询参数,查询结果分页显示时每页显示的记录数,默认值为10,取值范围为大于等于1的整数。

响应参数

Status Code: 200 OK

参数

类型

描述

totalCount

Long(>=0)

查询到的订阅记录总数。

pageNo

Long(>=0)

查询的页码。

pageSize

Long(>=0)

查询每页信息的数量。

subscriptions

List<QuerySubscriptionDTOCloud2NA>

订阅信息列表。

QuerySubscriptionDTOCloud2NA:

参数

类型

描述

subscriptionId

String

订阅ID号,用于唯一标识一个订阅,在创建订阅时由物联网平台分配获得。

notifyType

String

通知类型。

callbackUrl

String

订阅的回调地址。

请求示例

GET https://{host}:{port}/iocm/app/sub/v1.2.0/subscriptions?appId={appId}&notifyType={notifyType}&pageNo={pageNo}&pageSize={pageSize}
Content-Type: application/json
app_key: ******
Authorization: Bearer *****

正常响应示例

Status Code: 200 OK
Content-Type: application/json

{
  "pageNo": 0,
  "pageSize": 100,
  "totalCount": 10,
  "subscriptions": [
    {
      "subscriptionId": "*******",
      "notifyType": "*******",
      "callbackUrl": "*******"
    }
  ]
}

错误码

Http状态码

错误码

错误描述

说明

400

100224

The resource exceeds 1000, please refinement query conditions.

查到端资源超出1000条,请重新设定查询条件。

处理建议:请缩小查询条件范围。

403

100217

The application hasn't been authorized.

应用未被授权。

处理建议:若非应用授权场景,请确认请求参数中的appId为空。

403

1010009

app throttle exceed.

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

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

403

1010005

Invalid access token or appId.

错误的token信息。

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

相关使用指南

订阅推送

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问