视频监控

  • 视频监控 > api 文档 > 流管理相关接口 >获取流列表

    获取流列表

    最近更新时间:2020-10-22 15:50:17

    描述

    本接口用于获取流列表

    • 接口请求域名:qvs.qiniuapi.com
    • 请求方式:GET
    • 接口路径:/v1/namespaces/{namespaceid}/streams?offset=<offset>&line=<line>&qtype=<qtype>&prefix=<prefix>&sortBy=<sortBy>

    请求参数

    路径参数

    参数名称 必填 字段类型 说明
    namespaceId string 空间名称ID
    offset integer 在全部流中的偏移量
    line integer 一次返回多少条
    qtype integer 查询流类型, 0:全部,1:在线流,2:离线流
    prefix string 流ID 前缀,可以流ID 前缀进行检索查询
    sortBy string asc 表示升序, desc 表示降序, 默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt, lastPushedAt). asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序

    响应参数

    参数名称 类型 说明
    items 流数组 流数组
    items.streamId string 流ID
    items.desc string 描述
    items.nsId string 所属空间ID
    items.nsName string 所属空间名称
    items.recordTemplateId string 录制模版ID
    items.snapshotTemplateId string 截图模版ID
    items.disabled boolean 流是否被禁用
    items.lastPushedAt integer 最后一次推流时间,0:表示流从创建开始尚未进行过推流操作
    items.status bool 流是否在线
    items.createdAt integer 流创建时间
    items.updatedAt integer 流更新时间
    items.userCount integer 在线观看人数(只有在流在线的时候才会出现)
    items.clientIp integer 推流端IP(只有在流在线的时候才会出现)
    items.audioFrameRate integer 直播流的实时音频帧率(只有在流在线的时候才会出现)
    items.bitRate integer 直播流的实时码率(只有在流在线的时候才会出现)
    items.videoFrameRate integer 直播流的实时视频帧率(只有在流在线的时候才会出现)
    total integer 空间下流总数

    示例

    请求示例

    curl --request GET \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarrpj8lcl/streams \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

    响应示例

    {
      "items": [
        {
          "streamId": "abcdef",
          "nsId": "2akrarrpj8lcl",
          "nsName": "test_name3",
          "recordTemplateId": "2akrarrviqwvu",
          "snapshotTemplateId": "",
          "createdAt": 1586258862,
          "updatedAt": 1586258862,
          "status": false,
          "disabled": false,
          "lastPushedAt": 0
        },
        {
          "streamId": "xcfdde",
          "nsId": "2akrarrpj8lcl",
          "nsName": "test_name3",
          "recordTemplateId": "2akrarrpisqps",
          "snapshotTemplateId": "",
          "createdAt": 1585898236,
          "updatedAt": 1585898236,
          "status": false,
          "disabled": false,
          "lastPushedAt": 0
        },
        {
          "streamId": "xcfdd",
          "nsId": "2akrarrpj8lcl",
          "nsName": "test_name3",
          "recordTemplateId": "",
          "snapshotTemplateId": "",
          "createdAt": 1585896582,
          "updatedAt": 1585896582,
          "status": false,
          "disabled": false,
          "lastPushedAt": 0
        }
      ],
      "total": 3
    }
    }
    
    以上内容是否对您有帮助?
  • Qvm free helper
    Close