You need to enable JavaScript to run this app.
导航

获取音视频列表

最近更新时间2024.01.18 14:39:29

首次发布时间2021.06.16 16:26:53

此接口用于获取音视频信息列表。

使用说明

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

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 数据量限制:此接口最多可获取指定筛选条件的前 10000 条数据。若已知数据超过 10000 条,建议限定 StartTime 和 EndTime 来分批获取数据。

请求说明

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

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringGetMediaList接口名称。当前 API 的名称为 GetMediaList
VersionString2022-12-01接口版本。当前 API 的版本为 2022-12-01

SpaceName

String

test

点播空间名称。可通过以下方式获取空间名称:

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。

Vid

String

v03843g1000***k9s1v0rfphkjtc0

音视频 ID。音视频上传后,获取 Vid 的方式如下所示。

Status

String

Published

视频状态。不传默认全部。取值如下:

  • Published:发布。
  • Unpublished:未发布。

说明

多个状态用 , 隔开,如:"Published,Unpublished"

Order

String

Asc

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

  • Asc:升序。
  • Desc:降序。

Tags

String

tag1

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

说明

空值或重复值均会过滤。

ClassificationIds

String

0

分类 ID 列表。多个 ID 用逗号隔开。

  • 传空,不做筛选。
  • 传 0,只筛选出未分类的。
  • 传指定分类 ID,按照 ID 筛选。

说明

一次最多查询 20 个分类 ID。

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

TosStorageClasses

String

STANDARD

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

  • STANDARD:标准存储;
  • ARCHIVE:归档存储。
  • IA:低频存储。

VodUploadSources

String

upload

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

  • upload:上传
  • live:直播录制
  • rtc:RTC 录制
  • url_upload:URL 批量上传
  • media_process:视频处理
  • media_edit:视频剪辑

返回参数

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

参数类型示例值描述
SpaceNameStringtest点播空间名称。
MediaInfoListArray of MediaInfoList-音视频信息列表。
TotalCountInteger1符合条件的音视频总数。最大值为 10000。
OffsetInteger0当前查询的偏移量。
PageSizeInteger5列表页大小。每页返回记录条数。最大值为 100。

MediaInfoList

参数类型示例值描述
BasicInfoObject of BasicInfo-音视频基础信息。
SourceInfoObject of SourceInfo-原视频信息。

TranscodeInfos

Array of String

转码视频信息列表。

说明

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

BasicInfo

参数类型示例值描述
SpaceNameStringtest点播空间名称。
VidStringv03843g10001***9s1v0rfphkjtc0视频 ID。
TitleString视频视频名称。
DescriptionString视频测试视频描述。
PosterUriStringtos-vod-cn-**cf9d8997b3/4be2e03662b***8556f6a601611封面图对象存储地址。

PublishStatus

String

Unpublished

发布状态,取值如下:

  • Published:发布。
  • Unpublished:未发布。
TagsArray of Stringtag1音视频标签列表。
CreateTimeString2023-10-10T07:18:43Z音视频创建时间。
ClassificationObject of Classification-音视频分类信息。

TosStorageClass

String

STANDARD

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

  • STANDARD:标准存储。
  • ARCHIVE:归档存储。
  • IA:低频存储。

VodUploadSource

String

upload

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

  • upload:上传
  • live:直播录制
  • rtc:RTC 录制
  • url_upload:URL 批量上传
  • media_process:视频处理
  • media_edit:视频剪辑
HlsMediaSizeFloat4308617HlS 视频总和大小。

SourceInfo

参数类型示例值描述
FileIdStringv03843g10001***k9s1v0rfphkjtc0文件 ID。
Md5Stringdd9fd3ad7f99ff***0609aec68589Hash 值。

FileType

String

video

文件类型。取值如下:

  • video:视频。
  • audio:音频。
CodecStringh264编码格式。
HeightInteger720视频高度。
WidthInteger1280视频宽度。
FormatStringHLS文件格式。
DurationFloat15.12时长。
SizeDouble221文件大小。
StoreUriStringtos-vod-cn-***cf9d8997b3/c3f39620eddd4***dac3a8f49c05c.m3u8对象存储地址。
DefinitionStringunknown视频分辨率。
BitrateInteger116码率,单位为 bps。
FpsFloat25帧率。
CreateTimeString2023-10-10T07:18:43Z创建时间。
QualityString音频质量。

DynamicRange

String

SDR

动态范围。取值如下:

  • HDR
  • SDR
VideoStreamMetaObject of VideoStreamMeta-视频流信息。
AudioStreamMetaObject of AudioStreamMeta-音频流信息。

TosStorageClass

String

STANDARD

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

  • STANDARD:标准存储。
  • ARCHIVE:归档存储。
  • IA:低频存储。

Classification

参数类型示例值描述
SpaceNameStringtest点播空间名称。
ClassificationIdLong1分类 ID。

Level

Integer

1

分类级别,取值如下:

  • 1:一级分类
  • 2:二级分类
  • 3:三级分类
ClassificationString一级分类分类名称。
ParentClassificationIdLong0父分类 ID。
SubClassificationObject of SubClassification-子分类信息。
SubClassificationTreesArray of SubClassificationTrees-子分类列表。
CreatedAtString2022-02-18T15:08:07+08:00创建时间。

VideoStreamMeta

参数类型示例值描述
CodecStringh264视频编码格式。
HeightInteger720视频高度。
WidthInteger1280视频宽度。
DurationFloat15.12视频时长。
DefinitionStringunknown视频清晰度。
BitrateInteger116视频码率,单位为 bps。
FpsFloat25帧率。

AudioStreamMeta

参数类型示例值描述
CodecStringaac音频编码格式。
DurationFloat0音频时长。
SampleRateInteger48000音频采样率。
BitrateInteger0音频码率,单位为 bps。
QualityStringhigher音频质量。
ChannelsInteger4音频声道数。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20231010193***AC7B057070565895F",
    "Action": "GetMediaList",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "SpaceName": "test",
    "MediaInfoList": [
      {
        "BasicInfo": {
          "SpaceName": "test",
          "Vid": "v03843g10001***9s1v0rfphkjtc0",
          "Title": "",
          "Description": "",
          "PosterUri": "tos-vod-cn-**cf9d8997b3/4be2e03662b***8556f6a601611",
          "PublishStatus": "Unpublished",
          "Tags": [],
          "CreateTime": "2023-10-10T07:18:43Z",
          "Classification": null,
          "TosStorageClass": "STANDARD",
          "VodUploadSource": "upload",
          "HlsMediaSize": 4308617
        },
        "SourceInfo": {
          "FileId": "v03843g10001***k9s1v0rfphkjtc0",
          "Md5": "dd9fd3ad7f99ff***0609aec68589",
          "FileType": "video",
          "Codec": "h264",
          "Height": 720,
          "Width": 1280,
          "Format": "HLS",
          "Duration": 15.12,
          "Size": 221,
          "StoreUri": "tos-vod-cn-***cf9d8997b3/c3f39620eddd4***dac3a8f49c05c.m3u8",
          "Definition": "unknown",
          "Bitrate": 116,
          "Fps": 25,
          "CreateTime": "2023-10-10T07:18:43Z",
          "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": "",
            "Channels": 4
          },
          "TosStorageClass": "STANDARD",
          "FileName": ""
        },
        "TranscodeInfos": []
      }
    ],
    "TotalCount": 1,
    "Offset": 0,
    "PageSize": 5
  }
}

错误码

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

服务端 SDK

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