跳转到内容
WPF API图书馆

设备详情

接口说明

Section titled “接口说明”

根据设备 ID 获取单台设备的详细信息，包含设备基本属性、地理位置、在线与运行状态、配置对象、支持的指令列表以及权限标志。

请求信息

Section titled “请求信息”
项目 内容
方法 GET
路径 /api/devices/{id}
服务 核心业务 API（域名见快速开始）
鉴权 是，请求头携带 Authorization: Bearer your_token_here

请求参数

Section titled “请求参数”
参数名 类型 必填 说明
id int 是 路径参数，设备 ID

请求示例

Section titled “请求示例”
Terminal window
curl -X GET "/api/devices/101" \
  -H "Authorization: Bearer your_token_here" \
  -H "Accept: application/json"

响应参数

Section titled “响应参数”
字段 类型 说明
code int 状态码，0 表示成功
message string 响应描述
data.id int 设备 ID
data.device_no string 设备编号
data.name string 设备名称
data.type_id int 设备类型 ID
data.type_name string 设备类型名称
data.type_code string 设备类型代码
data.device_type_code string 设备分类标识（如 dog / car / drone / camera），用于判断控制方式与是否带摄像头
data.company_name string 所属公司名称
data.manager_name string 负责人姓名
data.model string 设备型号
data.protocol string 通信协议（如 websocket / mqtt / rtsp）
data.ip_address string|null 设备 IP 地址
data.port int|null 设备端口
data.location string 位置描述
data.longitude number 经度
data.latitude number 纬度
data.online_status int 在线状态：1 = 在线，0 = 离线
data.running_status int 运行状态码
data.is_online bool 是否在线
data.is_online_text string 在线状态文字描述
data.running_status_text string 运行状态文字描述
data.last_online_at string 最近上线时间
data.config object 设备配置（结构因设备类型而异）
data.commands array 设备支持的指令列表
data.current_firmware_version string|null 当前固件版本，可为空
data.control_mode string 控制模式（如 kinematic 运动学 / gimbal 云台）
data.control_params array 控制参数字段（如 ["vx","vy","vyaw"]）
data.supported_ws_actions array 支持的实时 WebSocket 动作列表
data.can_view bool 当前账号是否有查看权限
data.can_control bool 当前账号是否有控制权限（permission_type ≥ 2）
data.can_video bool 当前账号是否有视频查看权限

成功响应

Section titled “成功响应”
{
  "code": 0,
  "message": "success",
  "data": {
    "id": 101,
    "device_no": "DEV-2024-001",
    "name": "1号巡检机器人",
    "type_id": 3,
    "type_name": "巡检机器人",
    "type_code": "inspection_robot",
    "device_type_code": "dog",
    "company_name": "示例科技有限公司",
    "manager_name": "张三",
    "model": "IR-X200",
    "protocol": "websocket",
    "ip_address": "192.168.1.100",
    "port": 8080,
    "location": "A区变电站",
    "longitude": 121.473701,
    "latitude": 31.230416,
    "online_status": 1,
    "running_status": 1,
    "is_online": true,
    "is_online_text": "在线",
    "running_status_text": "运行中",
    "last_online_at": "2026-07-05 10:23:45",
    "config": {
      "speed_limit": 1.5,
      "auto_return": true
    },
    "commands": ["start_patrol", "stop", "return_home"],
    "current_firmware_version": "2.3.1",
    "control_mode": "kinematic",
    "control_params": ["vx", "vy", "vyaw"],
    "supported_ws_actions": ["telemetry", "video"],
    "can_view": true,
    "can_control": true,
    "can_video": true
  }
}

失败响应

Section titled “失败响应”
{
  "code": 404,
  "message": "设备不存在",
  "data": null
}
{
  "code": 30002,
  "message": "无设备查看权限",
  "data": null
}