批量查询订阅
典型场景
第三方应用可在物联网平台上创建多个订阅,以订阅不同类型的设备变更通知。第三方应用若需要查看本应用下所有订阅配置,或者查看某种订阅类型下的所有订阅配置,可调用此接口进行查询。
接口功能
支持第三方应用在物联网平台查询本应用下的所有订阅信息,或者某种订阅类型下的所有订阅信息。
接口描述
1
|
QueryBatchSubOutDTO queryBatchSubscriptions(QueryBatchSubInDTO qbsInDTO, String accessToken) throws NorthApiException |
参数说明
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
qbsInDTO |
必选 |
QueryBatchSubInDTO |
query |
见下表QueryBatchSubInDTO的描述。 |
accessToken |
必选 |
String |
header |
QueryBatchSubInDTO
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
appId |
可选 |
String(256) |
query |
设备或者规则等订阅内容主体所属的appId。 |
notifyType |
可选 |
String(256) |
query |
通知类型,第三方应用可以根据通知类型对消息分别进行处理。
|
pageNo |
可选 |
Integer |
query |
分页查询参数。
|
pageSize |
可选 |
Integer |
query |
分页查询参数,取值大于等于1的整数,缺省值:10。 |
响应参数
QueryBatchSubOutDTO
参数 |
类型 |
描述 |
---|---|---|
totalCount |
long |
查询到的订阅记录总数。 |
pageNo |
long |
查询的页码。 |
pageSize |
long |
查询每页信息的数量。 |
subscriptions |
List<SubscriptionDTO> |
订阅信息列表,具体参见SubscriptionDTO结构体。 |
参数 |
类型 |
描述 |
---|---|---|
subscriptionId |
String |
订阅ID号。 |
notifyType |
String |
通知类型。 |
callbackUrl |
String |
订阅的回调地址。 |
错误码
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是否有误。 |