AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 视频点播 开发参考 服务端API/SDK API参考 API目录 媒资管理 音视频管理 GetVideoInfos - 批量获取音视频信息

GetVideoInfos - 批量获取音视频信息

更新时间：
产品详情
我的收藏

调用本接口通过音/视频ID批量获取多个音视频的标题、描述、时长、封面URL、状态、创建时间、大小、截图、分类和标签等信息。

接口说明

  • 一次最多获取 20 个音视频的信息。

  • 音视频上传完成后，点播会对上传完成的音视频源文件进行分析，因此媒资信息是异步生成的。可通过设置音视频分析完成的事件通知，当接收到音视频分析完成的事件通知后，再调用本接口获取音视频信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vod:GetVideoInfos

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
VideoIds

string

否

音/视频 ID 列表。多个 ID 之间使用半角逗号（,）分隔，最多支持 20 个。可通过以下方式获取音/视频 ID：

  • 通过控制台上传的视频，可登录点播控制台，选择媒资库 > 音/视频查看音/视频 ID。

  • 通过获取视频上传地址和凭证接口获取上传地址和凭证时，音/视频 ID 为返回参数 VideoId 的值。

  • 音/视频上传后，可通过搜索媒体信息接口查询音/视频 ID，为请求后返回参数 VideoId 的值。

7753d144efd8e649c6c45fe0579****,7753d144efd74d6c45fe0570****
ReferenceIds

string

否

123-123,1234-1234

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

25818875-5F78-4AF6-D7393642CA58****
NonExistVideoIds

array

不存在的音/视频 ID 列表。

string

不存在的音/视频 ID 列表。

["7753d144efd8e649c6c45fe0579****"]
NonExistReferenceIds

array

string

123-123
VideoList

array<object>

音/视频信息列表。

object

音/视频信息详情。

StorageLocation

string

音/视频存储地址。

out-****.oss-cn-shanghai.aliyuncs.com
CreationTime

string

音/视频创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2017-06-26T05:38:48Z
Status

string

视频状态。取值：

  • Uploading：上传中。

  • UploadFail：上传失败。

  • UploadSucc：上传完成。

  • Transcoding：转码中。

  • TranscodeFail：转码失败。

  • Blocked：屏蔽。

  • Normal：正常。

Normal
CateId

integer

分类 ID。

781111****
VideoId

string

音/视频 ID。

7753d144efd74d6c45fe0570****
DownloadSwitch

string

离线下载开关状态，打开离线下载功能后，则允许移动端用户通过阿里云播放器将视频缓存至本地观看。具体操作，请参见离线下载。取值：

  • on：开启，允许离线下载。

  • off：关闭，禁止离线下载。

on
Tags

string

音/视频标签。多个标签之间使用半角逗号（,）分隔。

标签1, 标签2
ModificationTime

string

音/视频的最后一次更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2017-06-26T06:38:48Z
CateName

string

分类名称。

分类名称
Description

string

音/视频描述。

阿里云VOD视频描述
AppId

string

应用 ID。

app-****
Size

integer

音/视频源文件大小。单位：字节。

453
CoverURL

string

音/视频封面 URL。

https://example.aliyundoc.com/****.jpg
TemplateGroupId

string

转码模板组 ID。

b4039216985f4312a5382a4ed****
Duration

number

音/视频时长。单位：秒。

120
Title

string

音/视频标题。

阿里云VOD视频标题
Snapshots

array

视频截图 URL 数组。

string

视频截图 URL 数组。

说明

本接口仅会返回视频的封面截图数据，通过视频截图功能截取的普通截图、雪碧截图、雪碧图原始图、WebVTT 截图的截图数据，请调用 ListSnapshots 接口查询。

["http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****","http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****",...]
StorageClass

string

媒资存储类型。取值：

  • Standard：标准。

  • IA：媒资低频。

  • Archive：媒资归档。

  • ColdArchive：媒资冷归档。

  • SourceIA：源文件低频。

  • SourceArchive：源文件归档。

  • SourceColdArchive：源文件冷归档。

  • Changing：媒资存储类型变更中。

  • SourceChanging：源文件存储类型变更中。

Standard
RestoreStatus

string

媒资解冻状态。取值：

  • Processing：解冻中。

  • Success：解冻成功。

  • Failed：解冻失败。

Success
RestoreExpiration

string

媒资解冻有效期。

2023-03-30T10:14:14Z
UserData

string

自定义设置。为 JSON 字符串，支持消息回调、上传加速等设置。更多信息，请参见 UserData 。

{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
ReferenceId

string

123-123

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "NonExistVideoIds": [
    "[\"7753d144efd8e649c6c45fe0579****\"]"
  ],
  "NonExistReferenceIds": [
    "123-123"
  ],
  "VideoList": [
    {
      "StorageLocation": "out-****.oss-cn-shanghai.aliyuncs.com",
      "CreationTime": "2017-06-26T05:38:48Z",
      "Status": "Normal",
      "CateId": 0,
      "VideoId": "7753d144efd74d6c45fe0570****",
      "DownloadSwitch": "on",
      "Tags": "标签1, 标签2",
      "ModificationTime": "2017-06-26T06:38:48Z",
      "CateName": "分类名称",
      "Description": "阿里云VOD视频描述",
      "AppId": "app-****",
      "Size": 453,
      "CoverURL": "https://example.aliyundoc.com/****.jpg",
      "TemplateGroupId": "b4039216985f4312a5382a4ed****",
      "Duration": 120,
      "Title": "阿里云VOD视频标题",
      "Snapshots": [
        "[\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\",\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****\",...]"
      ],
      "StorageClass": "Standard",
      "RestoreStatus": "Success",
      "RestoreExpiration": "2023-03-30T10:14:14Z",
      "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"},\"Extend\":{\"localId\":\"*****\",\"test\":\"www\"}}",
      "ReferenceId": "123-123"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：GetVideoInfo - 获取单个音视频信息下一篇：GetVideoList - 获取音视频信息列表