/api/device/list

获取指定类型的设备列表,该接口在POST模式时为查询指定序列号列表的设备信息,参考:查询指定序列号列表设备

需要设备查看权限

接口原型

协议 HTTP/HTTPS GET
URL ip[:port]/api/device/list
数据格式 响应消息:Content-Type: application/json

可通过参数来指定想要获取的设备列表,指定多个不同参数将得到交集:

  • reg-state 注册状态,如不提供默认为accepted,可选值如下:
    • accepted 通过审核的设备
    • rejected 已拒绝的设备
    • waiting 等待审核的设备
  • catalog 所属组,仅当reg-state为accepted时才有效
  • module 产品族编号
  • sort 排序方式
  • order 指定升序还是降序,可设置:descending, ascending
  • is-favorite 是否在收藏列表中,值为1代表仅获取收藏列表中的设备,为0代表不做筛选
  • dir 设备可支持的流方向,不设置则表示没有,设置为input表示可作为源加入channel,output表示可作为输出加入到channel
  • status 设备状态,根据需求选择1到多个下列值,以逗号分隔,结果为各条件的并集:
    • dev-warns 设备存在异常
    • offline 离线
    • warns 设备在ControlHub平台存在异常
  • key 关键字,只返回序列号或者名称中包含key的设备

参考设备信息

请求URL参数

参数 描述
reg-state 注册状态
catalog 所属组
module 产品族编号
is-favorite 是否是收藏设备
dir 流方向
status 设备状态
key sn/名称关键字
start 开始序号
count 返回的最大数量
sort 排序方式,支持 online-state,sn,name,time,model-name,不提供则默认online-state(是否在线)方式排序

online-stat的排序规则:

  • 首先将在线的排最前面
  • 在线/不在线 的设备中,再将申请时间/批准时间最新的排最前面
  • 上一条规则中,如果时间相同,再将序列号小的排前面

请求Cookies

名称 描述
mwcloud-sid 用于标识当前登录的字符串
mwcloud-uid 当前登录用户名

请求示例

请求待审核的设备列表:

GET /api/device/list?reg-state=waiting&start=0&count=1 HTTP/1.1
Accept: application/json, text/plain, */*
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;

响应参数

Response Header
参数 描述
Content-Type 取值为:'application/json; charset=UTF-8'
Response Body
参数 描述
result 返回码
start 开始编号
total 总数(非列表中数量)
global-config 参考设备连接全局配置信息
list 设备列表

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "list": [
        {
            "apply-date": 1686791151226,
            "catalog-id": 0,
            "config": null,
            "dev-type": 3329,
            "dev-warns": 0,
            "dir": 256,
            "firmware-ver": "1.5.248",
            "group-mask": 1,
            "hardware-ver": "A",
            "id": 605,
            "is-favorite": 0,
            "is-inherit": 1,
            "module": 1,
            "module-name": "Ultra Stream SDI",
            "name": "Ultra Stream A302190930002",
            "online-date": 0,
            "owner-i": [
                "Push"
            ],
            "private-id": 1658596456,
            "pro-feature": {
                "input": "",
                "live-ms": 0,
                "rec-ms": 0,
                "sd-option": 0,
                "sd-status": 0,
                "sd-total": 0,
                "sd-used": 0,
                "usb-option": 0,
                "usb-status": 0,
                "usb-total": 0,
                "usb-used": 0
            },
            "product-id": 770,
            "push-key": "[MGDEV]-A302190930002-6f6d33cc",
            "reg-state": 101,
            "sn": "A302190930002",
            "status": {
                "cur-status": 0,
                "eth": "",
                "firmware-ver": "1.5.248",
                "hardware-ver": "A",
                "is-online": false,
                "module-name": "Ultra Stream SDI",
                "name": "Ultra Stream A302190930002",
                "rndis": "",
                "up-time": 0,
                "upgrade-status": {
                    "percent": 0,
                    "ret": 0,
                    "step": 0
                },
                "wifi": ""
            },
            "type": 257,
            "usr-mask": 0,
            "warns": 0
        }
    ],
    "result": 0,
    "start": 0,
    "total": 1
}

与“”相关结果约

    找不到与“”相关的结果

    与“”相关结果约

      找不到与“”相关的结果