logo
控制台登录/注册
文档
客户端 API
服务端 API
实时音视频
服务端 API
API 概览
快速开始
调用方式
在线调试服务端 API
全局返回码
房间信令接口
混流转码接口
媒体服务接口
媒体文件接口
音视频流审核接口
场景服务接口
回调说明
使用 Postman 调试
当前页

SearchMedia

GET

https://rtc-api.zego.im/

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

注意

首次使用本接口之前，请确认是否已经开通 CDN 直播服务。若未开通，请前往 ZEGO 控制台 自助开通，详情请参考 控制台 - 服务配置 - CDN，或联系 ZEGO 技术支持开通。

调用频率限制
同一个 AppID 下所有房间：20 次/秒

Request

Query Parameters

    Action stringrequired

    Possible values: [SearchMedia]

    接口原型参数

    https://rtc-api.zego.im?Action=SearchMedia

    AppId uint32required

    💡公共参数。AppId，ZEGO 分配的用户唯一凭证。

    SignatureNonce stringrequired

    💡公共参数。随机字符串。

    Timestamp int64required

    💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。

    Signature stringrequired

    💡公共参数。签名，用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡公共参数。签名版本号。

    IsTest string

    Possible values: [true, false]

    Default value: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

    Vendor stringrequired

    Possible values: [Tencent, Ws, Huawei]

    可能的取值及对应的 CDN 厂商：

    • Tencent：腾讯云。
    • Ws：网宿。
    • Huawei：华为云。
    NamePrefix string

    文件名前缀，前缀匹配媒体文件的文件名，最长支持 20 个字节。

    注意：

    使用时，需对其内容执行 URL 编码（UrlEncode）处理。

    StartTime int

    搜索文件的开始时间（文件创建时间），Unix 时间戳，精确到秒。

    该参数仅在 Vendor 取值为 Tencent 时有效。

    EndTime int

    搜索文件的结束时间（文件创建时间），Unix 时间戳，精确到秒。

    该参数仅在 Vendor 取值为 Tencent 时有效。

    PageSize int

    返回的记录条数，默认值为 10。取值范围：PageNumber * PageSize + PageSize 不超过 5000。

    该参数仅在 Vendor 取值为 Tencent 时有效。

    PageNumber int

    取得第几页。取值范围：PageNumber * PageSize + PageSize 不超过 5000。

    该参数仅在 Vendor 取值为 Tencent 时有效。

    FileId string[]

    Possible values: >= 1, <= 10

    文件 ID 列表，最多支持输入 10 个 FileId，单个 FileId 的最大长度为 40 个字符。

    该参数仅在 Vendor 取值为 Tencent 时有效。

    StreamId string[]

    Possible values: >= 1, <= 10

    CDN 录制的流 ID 列表，最多支持输入 10 个 StreamId，匹配集合中的任意元素。

    该参数仅在 Vendor 取值为 Tencent 时有效。

    Marker string

    检索信息时的标记位，该参数不填写时，默认返回检索到的第一页信息列表。

    1. 第一次调用本接口，入参 Marker 传入为空。
    2. 再次调用本接口时，入参 Marker 取值为 NextMarker（返回结果中的标记位信息）。

    每次调用本接口发起请求时，响应结果中都会返回 NextMarker，开发者需要判断是否检索到最后一页。

    该参数在 Vendor 取值为 Ws、Huawei 时有效。

    MaxKeys integer

    Possible values: >= 1 and <= 1000

    Default value: 1000

    调用一次本接口，返回记录的最大条数，取值范围 [1, 1000]，默认为 1000。

    超过 MaxKeys 取值的信息列表，需要根据前一次调用本接口时、返回结果中的 NextMarker 取值，再次调用本接口进行查询。

    该参数在 Vendor 取值为 Ws、Huawei 时有效。

Responses​

成功
Schema
    Code number

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

    返回码说明处理建议
    0请求成功。-
    2输出参数错误。-
    3未开通相关权限。请联系 ZEGO 技术支持。
    4CDN 类型不匹配。请检查参数。
    5配置错误。请联系 ZEGO 技术支持。
    6请求过于频繁。请稍后重试。
    7鉴权失败。请检查鉴权参数是否正确。
    8获取鉴权配置失败。请联系 ZEGO 技术支持是否开通此服务。
    1000请求失败。请联系 ZEGO 技术支持。
    Message string

    操作结果描述。

    RequestId string

    请求 ID，由 ZEGO 服务端返回。

    Data object
    响应数据。
    Tencent object
    腾讯云 返回内容（Vendor 取 Tencent 时返回本参数）。
    RequestId string

    唯一请求 ID，由请求参数 Vendor 取值对应的 CDN 厂商（即 Tencent）返回，定位问题时需要提供该次请求的 RequestId。

    TotalCount number

    符合搜索条件的记录总数。最大值为 5000。当命中记录数超过 5000 时，该参数将返回 5000，而非实际命中总数。

    MediaInfoSet object[]
    媒体文件信息列表。
  • Array[
    • FileId string

    文件唯一标识，即 录制文件生成回调 中的 FileID。

    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：封禁。
    StorageClass string

    文件的存储类型。

    • STANDARD：标准存储。
    • STANDARD_IA：低频存储。
    • ARCHIVE：归档存储。
    • DEEP_ARCHIVE：深度归档存储。
    TranscodeInfo object
    媒体文件转码结果的相关信息，包括该媒体文件转码后的文件地址、规格、码率、分辨率等。
    TranscodeSet object[]
    媒体文件转码信息集合，每个元素代表 1 个转码结果。
  • Array[
    • Url string

    转码后的视频文件地址。

    Definition integer

    转码规格 ID，取值 0 表示原始文件。

    Bitrate integer

    “视频流码率”的平均值与“音频流码率”的平均值之和，单位：bps。

    Height integer

    视频流高度的最大值，单位：px。

    Width integer

    视频流宽度的最大值，单位：px

    Size integer

    媒体文件总大小，单位：字节。当媒体文件为 HLS 时，大小是 m3u8 和 ts 文件大小的总和。

    Duration float

    视频时长，单位：秒。

    Md5 string

    视频的 md5 值。

    Container string

    容器类型，例如 m4a，mp4 等。

    VideoStreamSet object[]
    视频流信息。
  • Array[
    • Bitrate integer

    视频流的码率，单位：bps。

    Height integer

    视频流的高度，单位：px。

    Width integer

    视频流的宽度，单位：px。

    Codec string

    视频流的编码格式，例如 h264。

    Fps integer

    帧率，单位：hz。

    CodecTag string

    编码标签，仅当 Codec 为 hevc 时有效。

    DynamicRangeInfo object
    画面动态范围信息。
    Type string

    画面动态范围信息。

    • SDR：Standard Dynamic Range 标准动态范围。
    • HDR：High Dynamic Range 高动态范围。
    HDRType string

    高动态范围类型标准，当 Type 为 HDR 时有效。

    • hdr10
    • hlg
  • ]
    • AudioStreamSet object[]
    音频流信息。
  • Array[
    • Bitrate integer

    音频流的码率，单位：bps。

    SamplingRate integer

    音频流的采样率，单位：hz。

    Codec string

    音频流的编码格式，例如 aac。

  • ]
    • DigitalWatermarkType string

    数字水印类型。

    • Trace：表示经过溯源水印处理。
    • CopyRight：表示经过版权水印处理。
    • None：表示没有经过任何水印处理。
    CopyRightWatermarkText string

    版权信息。

  • ]
  • ]
    • Huawei object
    华为云 返回内容（Vendor 取 Huawei 时返回本参数）。
    NextMarker string

    下一次检索时的索引。在下次调用本接口时，传入到请求参数 Marker 中。

    Keys object[]
    媒体文件信息列表。
  • Array[
    • ETag string

    媒体文件的 md5 值。

    Key string

    媒体文件的唯一标识，即 录制文件生成回调 中的 ObsObject。

    LastModified string

    媒体文件的最后一次修改时间。

    Size number

    媒体文件的大小。

    MediaUrl string

    媒体文件的地址。

  • ]
    • Ws object
    网宿云 返回内容（Vendor 取 Ws 时返回本参数）。
    NextMarker string

    下一次检索时的索引。在下次调用本接口时，传入到请求参数 Marker 中。

    Keys object[]
    媒体文件信息列表。
  • Array[
    • ETag string

    媒体文件的 md5 值。

    Key string

    媒体文件的唯一标识，即 录制文件生成回调 中的 PersistentId。

    LastModified string

    媒体文件的最后一次修改时间。

    Size number

    媒体文件的大小。

    MediaUrl string

    媒体文件的地址。

  • ]
Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址（不区分区域）
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
query
query
query
query
query
query
query
query
query
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

停止 CDN 录制

Next

删除媒体文件

当前页

返回到顶部