You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒资管理/获取音视频信息
获取音视频信息
最近更新时间：2024.11.12 20:33:35首次发布时间：2021.06.16 16:26:53
我的收藏

此接口用于获取指定 Vid（视频 ID）的音视频信息。

使用说明

您可以获取指定空间下全部音视频信息，或指定筛选条件获取空间下部分音视频信息。

注意事项

数据量限制：此接口最多可获取指定筛选条件的前 10000 条数据。若数据已知超过 10000 条，建议限定 StartTime 和 EndTime 来分批获取数据。

请求说明

请求地址：https://vod.volcengineapi.com?Action=GetMediaList&Version=2022-12-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数
类型
是否必选
示例值
描述
Action
String
是
GetMediaList
接口名称。当前 API 的名称为 GetMediaList。
Version
String
是
2022-12-01
接口版本。当前 API 的版本为 2022-12-01。
SpaceName
String
是
test
空间名称。可调用 ListSpace 接口获取当前账号下所有空间的名称。
Vid
String
否
v03843g1000***k9s1v0rfphkjtc0
视频 ID。将音视频上传至视频点播服务后，您可通过 FileUploadComplete 事件通知获取 Vid。
Status
String
否
Published

视频状态。不传默认获取全部状态的音视频信息。取值如下：

  • Published：发布。
  • Unpublished：未发布。

说明

多个状态用 , 隔开，如："Published,Unpublished"。

Order
String
否
Asc

按照创建时间排序方式。默认为 Desc。取值如下：

  • Asc：升序。
  • Desc：降序。
Tags
String
否
tag1

音视频标签列表。搜索命中其中一个标签的视频。例如传入 "tag1,tag2,tag3"，会返回带有其中一个标签的视频，即或关系。

说明

空值或重复值均会过滤。

ClassificationIds
String
否
0

分类 ID 列表。取值如下：

  • 传空：不做筛选。
  • 传 0：只筛选未分类的音视频。
  • 传指定分类 ID：获取指定分类的音视频信息。通过 ListVideoClassifications 获取分类 ID。

说明

多个分类 ID 用逗号隔开。一次最多查询 20 个分类 ID。

StartTime
String
否
2021-03-18T00:00:00Z
创建时间的开始时间。查询结果大于等于 StartTime。格式按照 ISO 8601 标准表示，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。例如 2021-03-18T00:00:00Z，默认 1999-01-01T00:00:00Z。
EndTime
String
否
2021-03-19T00:00:00Z
创建时间的结束时间。需要大于 StartTime。默认 now。格式按照 ISO 8601 标准表示，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。
Offset
String
否
0
数据偏移量。默认为 0。最大为 10000。
PageSize
String
否
10
列表页大小。每页返回记录条数。默认为 10，最大值为 100。
TosStorageClasses
String
否
STANDARD

存储类型。, 隔开的字符串，可以为空。取值如下：

  • STANDARD：标准存储。
  • ARCHIVE：归档存储。
  • IA：低频存储。
VodUploadSources
String
否
upload

音视频来源。多个来源用英文逗号 , 分隔。取值如下：

  • upload：通过视频点播控制台、客户端上传 SDK、点播服务端 SDK 等方式上传至视频点播的视频。
  • live：通过火山引擎视频直播录制并存储至视频点播的视频。
  • rtc：通过火山引擎 RTC 录制并存储至视频点播的视频。
  • url_upload：通过 URL 批量拉取方式上传至视频点播的视频。
  • media_process：通过视频点播媒体处理服务生成的、会生成新 Vid 的视频。例如您通过多媒体 AI 模板生成的精彩剪辑，系统会单独生成 Vid。
  • media_edit：通过视频点播剪辑服务生产的视频。
Title
String
否
测试

标题。支持模糊搜索音视频文件。

说明

对于英文标题的搜索设置，支持分词模糊搜索功能，即需要输入为一个完整词语。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
SpaceName
String
test
点播空间名称。
MediaInfoList
Object[]
-
音视频信息列表。
BasicInfo
Object
-
音视频基础信息。
SpaceName
String
test
点播空间名称。
Vid
String
v03843g10001***9s1v0rfphkjtc0
视频 ID。
Title
String
视频
视频名称。
Description
String
视频测试
视频描述。
PosterUri
String
tos-vod-cn-cf9d8997b3/4be2e03662b*8556f6a601611
封面图对象存储地址。
PublishStatus
String
Unpublished

发布状态，取值如下：

  • Published：发布。
  • Unpublished：未发布。
Tags
String[]
tag1
音视频标签列表。
CreateTime
String
2023-10-10T07:18:43Z
音视频创建时间。
Classification
Object
-
音视频分类信息。
SpaceName
String
test
点播空间名称。
ClassificationId
Long
1
分类 ID。
Level
Integer
1

分类级别，取值如下：

  • 1：一级分类
  • 2：二级分类
  • 3：三级分类
Classification
String
一级分类
分类名称。
ParentClassificationId
Long
0
父分类 ID。
SubClassification
Object
-
子分类信息。
SubClassificationTrees
Object[]
-
子分类列表。
CreatedAt
String
2022-02-18T15:08:07+08:00
创建时间。
TosStorageClass
String
STANDARD

视频存储类型。取值如下：

  • STANDARD：标准存储。
  • ARCHIVE：归档存储。
  • IA：低频存储。
VodUploadSource
String
upload

音视频来源。取值如下：

  • upload：通过视频点播控制台、客户端上传 SDK、点播服务端 SDK 等方式上传至视频点播的视频。
  • live：通过火山引擎视频直播录制并存储至视频点播的视频。
  • rtc：通过火山引擎 RTC 录制并存储至视频点播的视频。
  • url_upload：通过 URL 批量拉取方式上传至视频点播的视频。
  • media_process：通过视频点播媒体处理服务生成的、会生成新 Vid 的视频。例如您通过多媒体 AI 模板生成的精彩剪辑，系统会单独生成 Vid。
  • media_edit：通过视频点播剪辑服务生产的视频。
HlsMediaSize
Float
4308617
HlS 视频总和大小。
ExpireTime
String
2024-08-30T20:10:11+08:00

音视频文件过期时间。过期后该 Vid 对应的视频文件及其相关资源（转码产物、封面图等）将被永久删除。采用 ISO 日期格式。9999-12-31T23:59:59Z 表示永不过期。

注意

亚太东南（柔佛）地域暂不支持此参数。

SourceInfo
Object
-
片源信息。
FileId
String
v03843g10001***k9s1v0rfphkjtc0
文件 ID。
Md5
String
dd9fd3ad7f99ff***0609aec68589
文件 MD5 值。
FileType
String
video

文件类型。取值如下：

  • video：视频。
  • audio：音频。
Codec
String
h264
编码格式。
Height
Integer
720
视频高度，单位为 px。
Width
Integer
1280
视频宽度，单位为 px。
Format
String
HLS
文件格式。
Duration
Float
15.12
文件时长，单位为秒。
Size
Double
221
文件大小，单位为字节。
StoreUri
String
tos-vod-cn-cf9d8997b3/c3f39620eddd4dac3a8f49c05c.m3u8
对象存储地址。
Definition
String
unknown
视频分辨率。
Bitrate
Integer
116
码率，单位为 bps。
Fps
Float
25
帧率，单位为 fps。
CreateTime
String
2023-10-10T07:18:43Z
创建时间。
Quality
String
音频质量。
DynamicRange
String
SDR

动态范围。取值如下：

  • HDR
  • SDR
VideoStreamMeta
Object
-
视频流元信息。
Codec
String
h264
视频编码格式。
Height
Integer
720
视频高度，单位为 px。
Width
Integer
1280
视频宽度，单位为 px。
Duration
Float
15.12
视频时长，单位为秒。
Definition
String
unknown
视频清晰度。
Bitrate
Integer
116
视频码率，单位为 bps。
Fps
Float
25
帧率，单位为 fps。
AudioStreamMeta
Object
-
音频流元信息。
Codec
String
aac
音频编码格式。
Duration
Float
0
音频时长，单位为秒。
SampleRate
Integer
48000
音频采样率，单位为 Hz。
Bitrate
Integer
0
音频码率，单位为 bps。
Quality
String
higher
音频质量。
Channels
Integer
4
音频声道数。
TosStorageClass
String
STANDARD

视频存储类型。取值如下：

  • STANDARD：标准存储。
  • ARCHIVE：归档存储。
  • IA：低频存储。
TranscodeInfos
String[]

转码视频信息列表。

说明

默认不返回转码流，因此该结构体一般为空，是为了扩展考虑。您可以通过 GetMediaInfos 接口中的 Vid 参数获取转码流信息。

TotalCount
Integer
1
符合条件的音视频总数。最大值为 10000。
Offset
Integer
0
当前查询的偏移量。
PageSize
Integer
5
列表页大小。每页返回记录条数。最大值为 100。

请求示例

https://vod.volcengineapi.com?Action=GetMediaList&Version=2022-12-01&SpaceName=test&Vid=&Status=Unpublished&Order=Asc&Tags=&ClassificationIds=0&StartTime=&EndTime=&Offset=0&PageSize=10&TosStorageClasses=STANDARD&VodUploadSources=upload

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221228***5D51C38F7D766",
        "Action": "GetMediaList",
        "Version": "2022-12-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "SpaceName": "vod-v2-test",
        "MediaInfoList": [
            {
                "BasicInfo": {
                    "SpaceName": "vod-v2-test",
                    "Vid": "v02b69g10000***eceldf4j38tlog",
                    "Title": "",
                    "Description": "",
                    "PosterUri": "tos-cn-v-febf******2493fb7f82d4d13453580",
                    "PublishStatus": "Unpublished",
                    "Tags": [],
                    "CreateTime": "2022-12-28T08:58:18Z",
                    "Classification": {
                        "SpaceName": "vod-v2-test",
                        "ClassificationId": "1",
                        "Level": 1,
                        "Classification": "一级分类",
                        "ParentClassificationId": "0",
                        "SubClassification": null,
                        "SubClassificationTrees": [],
                        "CreatedAt": "2022-02-18T15:08:07+08:00"
                    },
                    "TosStorageClass": "STANDARD"
                },
                "SourceInfo": {
                    "FileId": "v02b69g100***eceldf4j38tlog",
                    "Md5": "f57a5ce801c***978cf8b072fa28d",
                    "FileType": "video",
                    "Codec": "h264",
                    "Height": 720,
                    "Width": 1280,
                    "Format": "HLS",
                    "Duration": 15.12,
                    "Size": 221,
                    "StoreUri": "tos-cn-v-febf3a******d06b463e81ce08e7f83797d9.m3u8",
                    "Definition": "unknown",
                    "Bitrate": 116,
                    "Fps": 25,
                    "CreateTime": "2022-12-28T08:58:18Z",
                    "Quality": "",
                    "DynamicRange": "SDR",
                    "VideoStreamMeta": {
                        "Codec": "h264",
                        "Height": 720,
                        "Width": 1280,
                        "Duration": 15.12,
                        "Definition": "unknown",
                        "Bitrate": 116,
                        "Fps": 25
                    },
                    "AudioStreamMeta": {
                        "Codec": "",
                        "Duration": 0,
                        "SampleRate": 48000,
                        "Bitrate": 0,
                        "Quality": ""
                    },
                    "TosStorageClass": "STANDARD"
                },
                "TranscodeInfos": []
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：