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

查询设备激活状态

典型场景

第三方应用通过“注册设备”接口在物联网平台注册设备后,在设备首次接入平台之前,设备的激活状态为false;当设备首次接入平台后,设备的激活状态为true(无论设备接入后是处于在线、离线或异常状态)。第三方应用可调用此接口查询设备在物联网平台的激活状态,确定设备是否已接入平台。

接口功能

支持第三方应用通过设备ID查询设备在物联网平台的激活状态,确认设备是否已接入平台。

接口描述

1
public function queryDeviceStatus($deviceId, $appId, $accessToken)

接口所属类

DeviceManagement

参数说明

参数

必选/可选

位置

描述

$deviceId

必选

path

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

$appId

必选

query

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

$accessToken

必选

header

填写鉴权接口获取的accessToken。

返回值

QueryDeviceStatusOutDTO

参数

描述

$deviceId

设备ID,用于唯一标识一个设备。

$activated

激活状态,设备是否通过验证码获取密码的状态标识。

  • “true”:已激活
  • “false”:未激活

$name

设备名称。

错误码

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

500

100203

The application is not existed.

应用不存在。

处理建议:

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

500

50252

Internal server error.

服务器运行内部错误。

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