查询设备状态
接口说明
应用服务器可调用此接口查询设备激活状态,可用于给设备下发命令前判断设备在线状态。
URI
| 请求方法 | GET |
|---|---|
| URI | /api/v3.0/devices/{deviceId}/status |
| 传输协议 | HTTPS |
请求参数
| 名称 | 必选/可选 | 类型 | 位置 | 说明 |
|---|---|---|---|---|
| app_key | 必选 | String | Header | 已鉴权应用的appId。 |
| Authorization | 必选 | String | Header | 请求的认证信息,值为“Bearer ******”,其中******为Auth鉴权接口返回的accessToken。 |
| deviceId | 必选 | String | Path | 设备ID。 |
| ownerAppId | 可选 | String | Query | 资源所属应用的appId,访问其他应用所持有的资源时需要填写。 |
响应参数
| 名称 | 类型 | 说明 |
|---|---|---|
| status | String(1-256) | 设备状态:未激活,在线、离线、异常。 |
请求示例
GET https://{host}:{port}/api/v3.0/devices/{deviceId}/status?ownerAppId={ownerAppId}
Content-Type: application/json
app_key: ********
Authorization: ********
响应示例
Status Code: 200 OK
Content-Type: application/json
{
"status" : "string"
} 错误码
| HTTP状态码 | HTTP状态码说明 | 错误码 | 错误码描述 |
|---|---|---|---|
| 200 | OK | - | - |
| 401 | Unauthorized | 100002 | Invalid access token. 处理建议:token无效,重新申请token。 |
| 403 | Forbidden | 100203 | The application does not exist. 处理建议:检查并填写正确的appId。 |
| 100217 | The application hasn't been authorized. 处理建议:应用没有被授权,检查该应用是否有权限。 | ||
| 404 | Not Found | 100403 | The device does not exist. 处理建议:设备已被删除或重新注册,可通过查询设备列表接口查询设备是否还在平台内。 |
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.