查询设备激活状态
典型场景
应用服务器通过“注册设备”接口在物联网平台注册设备后，在设备首次接入平台之前，设备的激活状态为false；当设备首次接入平台后，设备的激活状态为true（无论设备接入后是处于在线、离线或异常状态）。应用服务器可调用此接口查询设备在物联网平台的激活状态，确定设备是否已接入平台。
接口功能
支持应用服务器通过设备ID查询设备在物联网平台的激活状态，确认设备是否已接入平台。
接口原型
|
请求方法 |
GET |
|---|---|
|
请求地址 |
https://server:port/iocm/app/reg/v1.1.0/deviceCredentials/{deviceId}?appId={appId} |
|
传输协议 |
HTTPS |
请求参数
|
参数 |
必选/可选 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
|
app_key |
必选 |
String |
header |
访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。 |
|
Authorization |
必选 |
String |
header |
访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。 |
|
deviceId |
必选 |
String |
path |
设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 |
|
appId |
可选 |
String |
query |
访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。此处填写授权应用的appId。 |
响应参数
Status Code: 200 OK
|
参数 |
类型 |
描述 |
|---|---|---|
|
deviceId |
String(256) |
设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 |
|
activated |
Boolean |
激活状态，设备是否通过验证码获取密码的状态标识。
|
|
name |
String(256) |
设备名称。 |
请求示例
Method: GET
request:
https://server:port/iocm/app/reg/v1.1.0/deviceCredentials/{deviceId}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json
响应示例
response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
"deviceId": "*******",
"activated": "*******",
"name": "*******"
}
错误码
|
Http状态码 |
错误码 |
错误描述 |
说明 |
|---|---|---|---|
|
403 |
100203 |
The application is not existed. |
应用不存在。 处理建议：
|
|
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. |
应用不存在。 处理建议：
|
|
500 |
50252 |
Internal server error. |
服务器运行内部错误。 处理建议：物联网平台内部错误，请联系物联网平台维护人员处理。 |
