文档首页/ IoT物联网/ API参考/ 北向API参考/ 订阅管理/ 批量删除订阅
更新时间：2022-02-24 GMT+08:00
查看PDF
分享

批量删除订阅

典型场景

应用服务器若不再需要接收物联网平台推送的订阅通知消息，或者不再需要接收某类订阅通知消息，可调用此接口批量删除订阅配置，取消订阅。

接口功能

支持应用服务器在物联网平台批量删除订阅配置，可删除全部订阅，或删除指定订阅类型的所有订阅，或删除指定回调URL地址的所有订阅。

接口原型

请求方法

DELETE

请求地址

https://server:port/iocm/app/sub/v1.2.0/subscriptions?appId={appId}&notifyType={notifyType}&callbackUrl={callbackUrl}&channel={channel}

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

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

Authorization

必选

String

header

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

appId

可选

String(256)

query

访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。此处填写授权应用的appId。

notifyType

可选

String(256)

query

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

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

callbackUrl

可选

String(256)

query

订阅回调的URL地址。

channel

可选

String(32)

query

传输通道。

  • 当channel为空时，删除“传输通道”为“HTTP”的订阅。
  • 当channel为“MQTTS”时，删除“传输通道”为“MQTTS”的订阅。
  • 当channel为“HTTP”时，删除“传输通道”为“HTTP”的订阅。
  • 当channel取其他值时，不会删除订阅。

响应参数

Status Code: 204 No Content

请求示例

Method: DELETE
request: https://server:port/iocm/app/sub/v1.2.0/subscriptions?appId={appId}&notifyType={notifyType}&callbackUrl={callbackUrl}&channel={channel}
Header:
app_key: ******
Authorization: Bearer *****
Content-Type: application/json

响应示例

response:
Status Code: 204 No Content

错误码

Http状态码

错误码

错误描述

说明

403

100217

The application hasn't been authorized.

应用未被授权。

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

403

1010009

app throttle exceed.

应用调用接口过于频繁，超过流控值（默认值是100次/60s）。

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

403

1010005

App_key or access_token is invalid.

错误的token信息。

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

404

100225

The resource is not found

找不到资源。

处理建议：请检查订阅类型是否有误。
父主题： 订阅管理