更新时间:2022-02-24 GMT+08:00

删除设备

典型场景

已在物联网平台注册的设备,若不再需要接入平台时,第三方应用可调用此接口在物联网平台删除设备。后续若设备要再次接入平台,第三方应用需要在物联网平台重新注册设备。

接口功能

支持第三方应用在物联网平台删除已注册的设备,使设备无法再接入平台。

接口描述

1
void deleteDirectDevice(String deviceId, Boolean cascade, String appId, String accessToken) throws NorthApiException

接口所属类

DeviceManagement

参数说明

参数

必选/可选

类型

位置

描述

deviceId

必选

String

path

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

cascade

必选

Boolean

query

仅当设备下连接了非直连设备时生效,不设置时可填写null。

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

appId

必选

String

query

如果是本应用的设备,此参数值可以填写null,否则填写授权应用的appId。

accessToken

必选

String

header

如果调用了定时刷新token接口,此参数值可以填写null,否则要填写鉴权接口获取的accessToken。

返回值

void

错误码

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

App_key or access_token is invalid.

错误的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.

服务器运行内部错误。

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