更新时间:2023-04-13 GMT+08:00
分享

删除设备

接口说明

已在物联网平台注册的设备,若不再需要接入平台时,应用服务器可调用此接口在物联网平台删除设备,使设备无法再接入平台。后续设备若需要再次接入平台,则需重新注册设备。

URI

请求方法

DELETE

URI

/iocm/app/dm/v1.4.0/devices/{deviceId}

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

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

Authorization

必选

String

header

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

deviceId

必选

String

path

设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。

appId

可选

String

query

设备所属的应用ID,当删除授权应用下的设备时才需要填写。

cascade

可选

Boolean

query

仅当设备下连接了非直连设备时生效。默认值为true。

  • true,级联删除,即删除直连设备和其下的非直连设备。
  • false,删除直连设备,但是不删其下的非直连设备,并将非直连设备的属性变为直连设备属性。

响应参数

Status Code: 204 No Content

请求示例

DELETE https://{host}:{port}/iocm/app/dm/v1.4.0/devices/{deviceId}?appId={appId}&cascade={cascade}
Content-Type: application/json
app_key: ******
Authorization: Bearer ******

正常响应示例

Status Code: 204 No Content

错误码

Http状态码

错误码

错误描述

说明

403

100203

The application is not existed.

应用不存在。

处理建议:

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

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是否有误。

404

100403

The device is not existed.

设备不存在。

处理建议:物联网平台未找到deviceId对应的设备,请检查deviceId是否有误。

404

100418

The deviceData is not existed.

设备信息不存在。

处理建议:

  • 请求参数中携带的deviceId错误。请确认该deviceId是否属于该appId或者deviceId是否写错。
  • Header中携带的appId有误,请确认该appId下是否有该deviceId。
  • 如果URL中携带了可选参数appId,请检查该appId是否有误。

500

100203

The application is not existed.

应用不存在。

处理建议:

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

500

50252

Internal server error.

服务器运行内部错误。

处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。

相关文档