视频监控

  • 视频监控 > API Reference > 模板管理相关接口 >获取模板列表

    获取模板列表

    最近更新时间:2020-06-11 19:46:23

    描述

    本接口用于获取模板列表

    • 接口请求域名:qvs.qiniuapi.com
    • 请求方式:GET
    • 接口路径:/v1/templates?offset=<offset>&line=<line>&templateType=<templateType>&match=<match>&sortBy=<sortBy>&zone=<zone>

    请求参数

    路径参数

    参数名称 必填 字段类型 说明
    offset integer 在全部templates中的偏移量
    line integer 一次返回多少条
    sortBy string 默认按创建时间降序排列, sortBy由"asc/desc"和可参与排序的字段组成, 其中 asc 表示升序, desc 表示降序, 可参与排序的字段有createdAt, updatedAt. asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序
    templateType integer 模板类型,取值:0(录制模版), 1(截图模版)
    match string 模糊匹配查询(模版名称包含match串时返回)
    zone string zone为服务区域,可根据服务区域筛选出对应区域的下模板,可选项为z0, z1, z2. z0表示华东, z1表示华北、z2表示华南

    响应参数

    参数名称 类型 说明
    items 模版数组 模版数组
    items.name string 模版名称
    items.desc string 模版描述
    items.bucket string 模版对应的对象存储的bucket
    items.deleteAfterDays integer 存储过期时间,默认永久不过期
    items.fileType integer 文件存储类型,取值:0(普通存储),1(低频存储)
    items.recordFileFormat integer 录制文件存储格式,取值:0(m3u8格式存储)
    items.templateType integer 模板类型,取值:0(录制模版), 1(截图模版)
    items.recordType integer 录制模式, 0(不录制),1(实时录制)
    items.jpgOverwriteStatus boolean 开启覆盖式截图(一般用于流封面)
    items.jpgSequenceStatus boolean 开启序列式截图
    items.recordInterval integer 录制文件时长 单位为秒, 600~3600
    items.snapInterval integer 截图间隔, 单位为秒, 10~600
    items.tsFileNameTemplate string ts文件命名格式
    items.m3u8FileNameTemplate string m3u8文件命名格式
    items.jpgOverwriteFileNameTemplate string 覆盖式截图文件命名格式
    items.jpgSequenceFileNameTemplate string 序列式截图文件命名格式
    items.createdAt integer 模版创建时间
    items.updatedAt integer 模版更新时间
    total integer 模版总数量

    示例

    请求示例

    curl --request GET \
      --url http://qvs.qiniuapi.com/v1/templates?templateType=0 \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

    响应示例

    {
      "items": [
        {
          "id": "2akrars5b81f5",
          "name": "test0016",
          "desc": "this is a test",
          "bucket": "bucket-test1",
          "deleteAfterDays": 0,
          "templateType": 0,
          "fileType": 0,
          "recordType": 0,
          "recordFileFormat": 0,
          "tsFileNameTemplate": "record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts",
                "recordSnapFileNameTemplate": "record/snap/${namespaceId}/${streamId}/${startMs}.jpg",
          "createdAt": 1586850533,
          "updatedAt": 1586850533,
          "interval": 10
        },
        {
          "id": "d102sns2mwhd",
          "name": "test009",
          "bucket": "bucket-test1",
          "deleteAfterDays": 0,
          "templateType": 0,
          "fileType": 0,
          "interval": 5,
          "recordType": 1,
          "recordFileFormat": 0,
          "tsFileNameTemplate": "record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts",
          "recordSnapFileNameTemplate": "record/snap/${namespaceId}/${streamId}/${startMs}.jpg",
          "createdAt": 1585104103,
          "updatedAt": 1586849432,
          "interval": 10
        }
      ],
      "total": 2
    }
    
    以上内容是否对您有帮助?
  • Qvm free helper
    Close