查询设备列表,支持设备状态、设备类型、关键词、平台/地区、绑定平台、过期时间、标签等筛选。
基本信息
Path: /queryDevice
Method: POST
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
pageNum | number | 否 | 页码,默认 1。 |
pageSize | number | 否 | 每页条数,默认 10,最大 100。 |
statusType / type / activeName | number/string | 否 | 设备状态。all/allDevices 全部,expiringSoon=2 即将过期,expired/expiredDevices=3 已过期,unUsed=4 未使用,unAutoRenew=5 未自动续费。 |
equipmentType | string | 否 | 设备类型。支持 all、platform、self、platform_vps、local 或后端支持的 SDK 类型。默认 all。 |
keyword / name / extInfo | string/array | 否 | 设备名称、设备 IP、已使用店铺等关键词。字符串支持逗号、分号、空格或换行分隔。 |
sdkCode | string | 否 | SDK 设备类型编码。 |
bindPlatforms | array | 否 | 已绑定平台筛选。 |
platRegion | array | 否 | 设备归属筛选,格式如 [region, platform]。 |
startTime / endTime | string | 否 | 过期时间范围,也可传 expireDate: [start, end]。 |
ids | array | 否 | 已使用店铺 ID 筛选。 |
autoRebuy | number | 否 | 自动续费状态。 |
rdpStatus | number | 否 | 是否支持远程。 |
localTypes | number | 否 | 本地虚拟设备网络类型。 |
proxyFunc | number | 否 | 是否支持代理。 |
tagIds | array | 否 | 设备标签 ID。 |
orderByColumn / isAsc | string | 否 | 排序字段和排序方向,isAsc 支持 asc、desc。 |
补充说明
返回的 devices 会保留后端原始字段,并额外补充 deviceId、name、deviceName、deviceStatus 兼容字段。
请求示例
{
"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.code | number | 200 表示查询成功。 |
response.total | number | 符合条件的设备总数。 |
response.page / response.pageSize | number | 当前页码和每页条数。 |
response.devices | array | 设备列表。 |
response.devices[].deviceId | number/string | 设备记录 ID,对应后端 id。 |
response.devices[].ipId | number/string | 设备 IP ID。 |
response.devices[].equipmentType | string | 设备类型。 |
response.devices[].deviceStatus | number/string | 设备状态。 |
失败返回示例
{
"method": "queryDevice",
"status": "error",
"code": "400",
"msg": "query device failed"
}