菜单

设备查询

查询设备列表,支持设备状态、设备类型、关键词、平台/地区、绑定平台、过期时间、标签等筛选。

基本信息

Path: /queryDevice

Method: POST

请求参数

参数类型必填说明
pageNumnumber页码,默认 1
pageSizenumber每页条数,默认 10,最大 100
statusType / type / activeNamenumber/string设备状态。all/allDevices 全部,expiringSoon=2 即将过期,expired/expiredDevices=3 已过期,unUsed=4 未使用,unAutoRenew=5 未自动续费。
equipmentTypestring设备类型。支持 allplatformselfplatform_vpslocal 或后端支持的 SDK 类型。默认 all
keyword / name / extInfostring/array设备名称、设备 IP、已使用店铺等关键词。字符串支持逗号、分号、空格或换行分隔。
sdkCodestringSDK 设备类型编码。
bindPlatformsarray已绑定平台筛选。
platRegionarray设备归属筛选,格式如 [region, platform]
startTime / endTimestring过期时间范围,也可传 expireDate: [start, end]
idsarray已使用店铺 ID 筛选。
autoRebuynumber自动续费状态。
rdpStatusnumber是否支持远程。
localTypesnumber本地虚拟设备网络类型。
proxyFuncnumber是否支持代理。
tagIdsarray设备标签 ID。
orderByColumn / isAscstring排序字段和排序方向,isAsc 支持 ascdesc

补充说明

返回的 devices 会保留后端原始字段,并额外补充 deviceIdnamedeviceNamedeviceStatus 兼容字段。

请求示例

{
  "method": "queryDevice",
  "pageNum": 1,
  "pageSize": 20,
  "equipmentType": "platform",
  "statusType": "unUsed",
  "keyword": "device-name",
  "orderByColumn": "expireTime",
  "isAsc": "desc"
}

成功返回示例

{
  "method": "queryDevice",
  "response": {
    "code": 200,
    "msg": "success",
    "total": 1,
    "page": 1,
    "pageSize": 20,
    "pageTotal": 1,
    "devices": [
      {
        "id": 10001,
        "deviceId": 10001,
        "ipId": 20001,
        "name": "device-name",
        "deviceName": "device-name",
        "ipName": "device-name",
        "ipAddress": "127.0.0.1",
        "equipmentType": "platform",
        "deviceStatus": 1,
        "remark": "test"
      }
    ]
  }
}

返回字段

字段类型说明
response.codenumber200 表示查询成功。
response.totalnumber符合条件的设备总数。
response.page / response.pageSizenumber当前页码和每页条数。
response.devicesarray设备列表。
response.devices[].deviceIdnumber/string设备记录 ID,对应后端 id
response.devices[].ipIdnumber/string设备 IP ID。
response.devices[].equipmentTypestring设备类型。
response.devices[].deviceStatusnumber/string设备状态。

失败返回示例

{
  "method": "queryDevice",
  "status": "error",
  "code": "400",
  "msg": "query device failed"
}
上一个
编辑设备
下一个
各电商平台访问问题汇总
最近修改: 2026-06-03Powered by