服务端 API v2
  • API概览
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 回调说明
  • 全局返回码
  • 调测指南

检索媒体信息

更新时间:2021-12-23 18:25

1 描述

用户进行 CDN 录制时,会把录制好的媒体文件存放在 CDN 服务器上,用户可以调用本接口查询自己名下的媒体文件相关信息,例如媒体文件名、创建时间等。

首次使用本接口之前,需要联系 ZEGO 技术支持开通。

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=SearchMedia
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
Vendor String CDN 厂商名。
  • Tencent:腾讯云。
NamePrefix String 文件名前缀,前缀匹配媒体文件的文件名。最长支持 20 个字节。
StartTime Int 搜索文件的开始时间(文件创建时间),Unix 时间戳,精确到秒。
EndTime Int 搜索文件的结束时间(文件创建时间),Unix 时间戳,精确到秒。
PageSize Int 返回的记录条数,默认值为 10。取值范围:PageNumber * PageSize + PageSize 不超过 5000。
PageNumber Int 取得第几页。取值范围:PageNumber * PageSize + PageSize 不超过 5000。
FileId[] Array of String 文件 ID 集合,匹配集合中的任意元素。
  • 数组长度限制:10
  • 单个 ID 长度限制:40 个字符
StreamId[] Array of String CDN 录制的流 ID 列表,匹配集合中的任意元素。
数组长度限制:10

4 请求示例

https://rtc-api.zego.im/?Action=SearchMedia
&Vendor=Tencent
&NamePrefix=nameprefix
&StartTime=
&EndTime=
&PageSize=
&PageNumber=
&FileId[]=fileId1
&FileId[]=fileId2
&StreamId[]=streamId1
&StreamId[]=streamId2
&<公共请求参数>

5 响应参数

名称
类型
备注
Code Number 返回码。
Message String 操作结果描述。
RequestId String 请求 ID。
Data Object 响应数据。
└ Tencent Object 腾讯云返回内容(CDN 为腾讯云时返回本参数)。
  └ TotalCount Number 符合搜索条件的记录总数。最大值为 5000。当命中记录数超过 5000 时,该参数将返回 5000,而非实际命中总数。
  └ MediaInfoSet Array of Object 媒体文件信息列表。
    └ FileId String 文件唯一标识。
    └ BasicInfo Object 基础信息。包括视频名称、分类、播放地址、封面图片等。
      └ Name String 媒体名。
      └ Description String 媒体文件描述。
      └ CreateTime String 媒体文件的创建时间,使用 “ISO 日期格式”。
      └ UpdateTime String 媒体文件的最近更新时间(如修改视频属性、发起视频处理等会触发更新媒体文件信息的操作),使用 “ISO 日期格式”。
      └ ExpireTime String 媒体文件的过期时间,使用 “ISO 日期格式”。过期后该媒体文件及其相关资源(转码结果、雪碧图等)将被永久删除。“9999-12-31T23:59:59Z” 表示永不过期。
      └ ClassId Number 媒体文件的分类 ID。
      └ ClassName String 媒体文件的分类名称。
      └ ClassPath String 媒体文件的分类路径,分类间以 “-” 分隔,如 “新的一级分类 - 新的二级分类”。
      └ CoverUrl String 媒体文件的封面图片地址。
      └ Type String 媒体文件的封装格式,例如 mp4、flv 等。
      └ MediaUrl String 原始媒体文件的 URL 地址。
      └ SourceInfo Object 该媒体文件的来源信息。
        └ SourceType String 来源类型。
        └ SourceContext String 来源流。
      └ StorageRegion String 媒体文件存储地区,如 ap-guangzhou,参见[地域列表]。
      └ Vid String 直播录制文件的唯一标识。
      └ Category String 文件类型。
  • Video:视频文件。
  • Audio:音频文件。
  • Image:图片文件。
      └ Status String 文件状态。
  • Normal:正常。
  • Forbidden:封禁。
  └ RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "Data":{
        "Tencent":{
            "TotalCount":4,
            "MediaInfoSet":[
                {
                    "BasicInfo":{
                        "Name":"dt5",
                        "Description":"",
                        "CreateTime":"2021-01-25T09:13:56Z",
                        "UpdateTime":"2021-01-25T09:13:58Z",
                        "ExpireTime":"9999-12-31T23:59:59Z",
                        "ClassId":0,
                        "ClassName":"其他",
                        "ClassPath":"其他",
                        "CoverUrl":"",
                        "Type":"mp4",
                        "MediaUrl":"https://vod-qcloud-test.zego.im/ff6370f5vodcq1400341231/1bae3ab35285890813218549196/c0c0abace4e53b92dd5d0400.mp4",
                        "SourceInfo":{
                            "SourceType":"VideoProcessing",
                            "SourceContext":""
                        },
                        "StorageRegion":"ap-chongqing",
                        "Vid":"5285890813218549196",
                        "Category":"Video",
                        "Status":"Normal"
                    },
                    "FileId":"5285890813218549196"
                },
                {
                    "BasicInfo":{
                        "Name":"dt3",
                        "Description":"",
                        "CreateTime":"2021-01-25T09:10:53Z",
                        "UpdateTime":"2021-01-25T09:10:54Z",
                        "ExpireTime":"9999-12-31T23:59:59Z",
                        "ClassId":0,
                        "ClassName":"其他",
                        "ClassPath":"其他",
                        "CoverUrl":"",
                        "Type":"mp4",
                        "MediaUrl":"https://vod-qcloud-test.zego.im/ff6370f5vodcq1400341231/195801495285890813218447351/6fb39f94d2c5fb9190776064.mp4",
                        "SourceInfo":{
                            "SourceType":"VideoProcessing",
                            "SourceContext":""
                        },
                        "StorageRegion":"ap-chongqing",
                        "Vid":"5285890813218447351",
                        "Category":"Video",
                        "Status":"Normal"
                    },
                    "FileId":"5285890813218447351"
                },
                {
                    "BasicInfo":{
                        "Name":"dt2",
                        "Description":"",
                        "CreateTime":"2021-01-25T09:05:11Z",
                        "UpdateTime":"2021-01-25T09:10:43Z",
                        "ExpireTime":"9999-12-31T23:59:59Z",
                        "ClassId":0,
                        "ClassName":"其他",
                        "ClassPath":"其他",
                        "CoverUrl":"",
                        "Type":"mp4",
                        "MediaUrl":"https://vod-qcloud-test.zego.im/ff6370f5vodcq1400341231/14897a655285890813218227225/a9fd54b2818dc150990bef8a.mp4",
                        "SourceInfo":{
                            "SourceType":"VideoProcessing",
                            "SourceContext":""
                        },
                        "StorageRegion":"ap-chongqing",
                        "Vid":"5285890813218227225",
                        "Category":"Video",
                        "Status":"Normal"
                    },
                    "FileId":"5285890813218227225"
                },
                {
                    "BasicInfo":{
                        "Name":"dt1",
                        "Description":"",
                        "CreateTime":"2021-01-25T08:58:16Z",
                        "UpdateTime":"2021-01-25T09:10:43Z",
                        "ExpireTime":"9999-12-31T23:59:59Z",
                        "ClassId":0,
                        "ClassName":"其他",
                        "ClassPath":"其他",
                        "CoverUrl":"",
                        "Type":"mp4",
                        "MediaUrl":"https://vod-qcloud-test.zego.im/ff6370f5vodcq1400341231/d84db74c5285890813217983125/a1323481c903441370371e1d.mp4",
                        "SourceInfo":{
                            "SourceType":"VideoProcessing",
                            "SourceContext":""
                        },
                        "StorageRegion":"ap-chongqing",
                        "Vid":"5285890813217983125",
                        "Category":"Video",
                        "Status":"Normal"
                    },
                    "FileId":"5285890813217983125"
                }
            ],
            "RequestId":"151168a4-baf9-4c9c-a094-eeecf8cd6be5"
        }
    },
    "RequestId":"6877226848471811505"
}

7 返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码 说明
41001 直播保存失败。
41002 频道保存失败。
41003 直播不存在。
41004 流已不存在。
42001 禁用直播失败。
42002 恢复直播失败。
43001 创建录制索引文件失败。