文档中心
超低延迟直播
服务端 API
媒体文件接口
检索媒体信息

检索媒体信息

更新时间：2024-04-01 18:28

1 描述

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

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

2 接口原型

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

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

参数	类型	是否必选	描述
Vendor	String	是	可能的取值及对应的 CDN 厂商： Tencent：腾讯云。 Ws：网宿。 Huawei：华为云。
NamePrefix	String	否	文件名前缀，前缀匹配媒体文件的文件名，最长支持 20 个字节。使用时，请对该参数内容进行 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[]	Array of String	否	文件 ID 列表，最多支持输入 10 个 FileId，单个 FileId 的最大长度为 40 个字符。该参数仅在 Vendor 取值为 Tencent 时有效。
StreamId[]	Array of String	否	CDN 录制的流 ID 列表，最多支持输入 10 个 StreamId，匹配集合中的任意元素。该参数仅在 Vendor 取值为 Tencent 时有效。
Marker	String	否	检索信息时的标记位，该参数不填写时，默认返回检索到的第一页信息列表。第一次调用本接口，入参 Marker 传入为空。再次调用本接口时，入参 Marker 取值为 NextMarker（返回结果中的标记位信息）。每次调用本接口发起请求时，响应结果中都会返回 NextMarker，开发者需要判断是否检索到最后一页。该参数在 Vendor 取值为 Ws、Huawei 时有效。
MaxKeys	Int	否	调用一次本接口，返回记录的最大条数，取值范围 [1, 1000]，默认为 1000。超过 MaxKeys 取值的信息列表，需要根据前一次调用本接口时、返回结果中的 NextMarker 取值，再次调用本接口进行查询。该参数在 Vendor 取值为 Ws、Huawei 时有效。

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，由 ZEGO 服务端返回。
Data	Object	响应数据。
Tencent	Object	`腾讯云` 返回内容（Vendor 取 Tencent 时返回本参数）。
RequestId	String	唯一请求 ID，由请求参数 Vendor 取值对应的 CDN 厂商（即 Tencent）返回，定位问题时需要提供该次请求的 RequestId。
TotalCount	Number	符合搜索条件的记录总数。最大值为 5000。当命中记录数超过 5000 时，该参数将返回 5000，而非实际命中总数。
MediaInfoSet	Array of Object	媒体文件信息列表。
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：图片文件。 /ul>
Status	String	文件状态。 Normal：正常。 Forbidden：封禁。
StorageClass	String	文件的存储类型。 STANDARD：标准存储。 STANDARD_IA：低频存储。 ARCHIVE：归档存储。 DEEP_ARCHIVE：深度归档存储。
TranscodeInfo	Object	媒体文件转码结果的相关信息，包括该媒体文件转码后的文件地址、规格、码率、分辨率等。
TranscodeSet	Array of Object	媒体文件转码信息集合，每个元素代表 1 个转码结果。
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	Array of Object	视频流信息。
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	Array of Object	音频流信息。
Bitrate	Integer	音频流的码率，单位：bps。
SamplingRate	Integer	音频流的采样率，单位：hz。
Codec	Integer	音频流的编码格式，例如 aac。
DigitalWatermarkType	String	数字水印类型。 Trace：表示经过溯源水印处理。 CopyRight：表示经过版权水印处理。 None：表示没有经过任何水印处理。
CopyRightWatermarkText	String	版权信息。
Huawei	Object	`华为云` 返回内容（Vendor 取 Huawei 时返回本参数）。
NextMarker	String	下一次检索时的索引。在下次调用本接口时，传入到请求参数 Marker 中。
Keys	Array of Object	媒体文件信息列表。
ETag	String	媒体文件的 md5 值。
Key	String	媒体文件的唯一标识，即录制文件生成回调中的 ObsObject。
LastModified	String	媒体文件的最后一次修改时间。
Size	Number	媒体文件的大小。
MediaUrl	String	媒体文件的地址。
Ws	Object	`网宿云` 返回内容（Vendor 取 Ws 时返回本参数）。
NextMarker	String	下一次检索时的索引。在下次调用本接口时，传入到请求参数 Marker 中。
Keys	Array of Object	媒体文件信息列表。
ETag	String	媒体文件的 md5 值。
Key	String	媒体文件的唯一标识，即录制文件生成回调中的 PersistentId。
LastModified	String	媒体文件的最后一次修改时间。
Size	Number	媒体文件的大小。
MediaUrl	String	媒体文件的地址。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "Data":{
        "Tencent": {
            "TotalCount": 1,
            "MediaInfoSet": [
                {
                    "BasicInfo": {
                        "Name": "1690354361.mp4",
                        "Description": "",
                        "CreateTime": "2023-07-26T06:52:49Z",
                        "UpdateTime": "2023-07-26T10:21:33Z",
                        "ExpireTime": "9999-12-31T23:59:59Z",
                        "ClassId": 0,
                        "ClassName": "其他",
                        "ClassPath": "其他",
                        "CoverUrl": "",
                        "Type": "mp4",
                        "MediaUrl": "http://push.url/6cbbc436vodcq1500020831/03c1ada53270835011057780896/9e505713fb216f0b0232064f.mp4",
                        "SourceInfo": {
                            "SourceType": "VideoProcessing",
                            "SourceContext": ""
                        },
                        "StorageRegion": "ap-chongqing",
                        "Vid": "3270835011057780896",
                        "Category": "Video",
                        "Status": "Normal",
                        "StorageClass": "STANDARD"
                    },
                    "TranscodeInfo": {
                        "TranscodeSet": [
                            {
                                "Url": "http://push.url/6cbbc436vodcq1500020831/03c1ada53270835011057780896/9e505713fb216f0b0232064f.mp4",
                                "Definition": 0,
                                "Bitrate": 576721,
                                "Height": 360,
                                "Width": 640,
                                "Size": 2239086,
                                "Duration": 31.104,
                                "Md5": "",
                                "Container": "mov,mp4,m4a,3gp,3g2,mj2",
                                "VideoStreamSet": [
                                    {
                                        "Bitrate": 530177,
                                        "Height": 360,
                                        "Width": 640,
                                        "Codec": "h264",
                                        "Fps": 14,
                                        "CodecTag": "",
                                        "DynamicRangeInfo": {
                                            "Type": "SDR",
                                            "HDRType": ""
                                        }
                                    }
                                ],
                                "AudioStreamSet": [
                                    {
                                        "Bitrate": 46544,
                                        "SamplingRate": 16000,
                                        "Codec": "aac"
                                    }
                                ],
                                "DigitalWatermarkType": "None",
                                "CopyRightWatermarkText": ""
                            },
                            {
                                "Url": "http://push.url/43a5b1devodtranscq1500020831/03c1ada53270835011057780896/v.f100020.mp4",
                                "Definition": 100020,
                                "Bitrate": 427974,
                                "Height": 540,
                                "Width": 960,
                                "Size": 1677353,
                                "Duration": 31.151,
                                "Md5": "4f51593ed8e28b5d35553f4977d39547",
                                "Container": "mov,mp4,m4a,3gp,3g2,mj2",
                                "VideoStreamSet": [
                                    {
                                        "Bitrate": 363857,
                                        "Height": 540,
                                        "Width": 960,
                                        "Codec": "h264",
                                        "Fps": 25,
                                        "CodecTag": "avc1",
                                        "DynamicRangeInfo": {
                                            "Type": "SDR",
                                            "HDRType": ""
                                        }
                                    }
                                ],
                                "AudioStreamSet": [
                                    {
                                        "Bitrate": 64117,
                                        "SamplingRate": 44100,
                                        "Codec": "aac"
                                    }
                                ],
                                "DigitalWatermarkType": "None",
                                "CopyRightWatermarkText": ""
                            }
                        ]
                    },
                    "FileId": "3270835011057780896"
                }
            ],
            "RequestId": "c827629f-08b4-406c-b063-b660126e922f"
        },
        "Huawei": {
            "Keys": [
                {
                    "ETag": "\"ef4e0314095b8aae02d7a5adaa60c94f\"",
                    "Key": "record/app/command_record/alinxu_test/2023-07-28-09-30-06.mp4",
                    "LastModified": "2023-07-28T09:31:29.176Z",
                    "Size": 2172786,
                    "MediaUrl": "http://push.url/record/app/command_record/alinxu_test/2023-07-28-09-30-06.mp4"
                }
            ],
            "NextMarker": ""
        },
        "Ws": {
            "Keys": [
                {
                    "ETag": "lv1tsU6T8r9hDZietipfSphc806Y",
                    "Key": "app-alinxu_test--20230728181527.mp4",
                    "LastModified": "2023-07-28T10:16:44Z",
                    "Size": 6441553,
                    "MediaUrl": "http://push.url/app-alinxu_test--20230728181527.mp4"
                }
            ],
            "NextMarker": ""
        }
    },
    "RequestId":"6877226848471811505"
}

7 返回码

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

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