删除单个订阅
典型场景
应用服务器若不再需要接收物联网平台推送的某个订阅通知消息时,可调用此接口删除指定的订阅配置,取消订阅。
接口功能
支持应用服务器在物联网平台根据订阅ID删除指定的订阅配置。
接口原型
请求方法 |
DELETE |
---|---|
请求地址 |
https://server:port/iocm/app/sub/v1.2.0/subscriptions/{subscriptionId}?appId={appId} |
传输协议 |
HTTPS |
请求参数
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
app_key |
必选 |
String |
header |
访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。 |
Authorization |
必选 |
String |
header |
访问物联网平台的认证信息,值为“Bearer {accessToken}”,其中{accessToken}为调用鉴权接口返回的accessToken。 |
subscriptionId |
必选 |
String(256) |
path |
订阅ID号,用于唯一标识一个订阅,在创建订阅时由物联网平台分配获得。 |
appId |
可选 |
String(256) |
query |
访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。此处填写授权应用的appId。 |
响应参数
Status Code: 204 No Content
请求示例
Method: DELETE request: https://server:port/iocm/app/sub/v1.2.0/subscriptions/{subscriptionId}?appId={appId} 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 |
找不到资源。 处理建议:请检查订阅ID是否有误。 |