全部产品
Search

搜索本产品

    视频点播：GetVideoInfo - 获取单个音视频信息

    文档中心

    视频点播：GetVideoInfo - 获取单个音视频信息

    更新时间：Dec 16, 2024

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

    接口说明

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    vod:GetVideoInfoget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    VideoIdstring是

    音/视频 ID，仅支持传入一个音/视频 ID。可通过以下方式获取：

    • 通过控制台上传的视频，可登录点播控制台，选择媒资库 > 音/视频查看音/视频 ID。
    • 通过获取视频上传地址和凭证接口获取上传地址和凭证时，音/视频 ID 为返回参数 VideoId 的值。
    • 音视频上传后，可通过搜索媒体信息接口查询音/视频 ID，为请求后返回参数 VideoId 的值。
    		9b73864d75f1d231e9001cd5f8****

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

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

    音/视频信息。

    StorageLocationstring

    音/视频存储地址。

    		out-201703232251****.oss-cn-shanghai.aliyuncs.com
    CreationTimestring

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

    		2017-11-14T09:15:50Z
    Statusstring

    音/视频状态。各状态可执行的操作及使用限制等详细信息，请参见Status：音视频状态。取值：

    • Uploading：上传中。
    • UploadFail：上传失败。
    • UploadSucc：上传完成。
    • Transcoding：转码中。
    • TranscodeFail：转码失败。
    • Blocked：屏蔽。
    • Normal：正常。
    		Normal
    CateIdlong

    分类 ID。

    		781111****
    VideoIdstring

    音/视频 ID。

    		9b73864d75f1d231e9001cd5f8****
    DownloadSwitchstring

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

    • on：开启，允许离线下载。
    • off：关闭，禁止离线下载。
    		on
    Tagsstring

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

    		标签1, 标签2
    ModificationTimestring

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

    		2017-11-14T10:15:50Z
    RegionIdstring

    音/视频存储所在地域。

    		cn-shanghai
    CustomMediaInfostring

    自定义媒资信息。

    说明 该参数已废弃，调用 API 已不会返回该参数。
    		{"aaa":"test"}
    CateNamestring

    分类名称。

    		分类名
    Descriptionstring

    音/视频描述。

    		阿里云VOD视频描述
    AppIdstring

    应用 ID。

    		app-****
    Sizelong

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

    		10897890
    CoverURLstring

    音/视频封面 URL。

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

    转码模板组 ID。

    		9ae2af636ca64835b0c10412f448****
    Durationfloat

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

    		135.6
    Titlestring

    音/视频标题。

    		阿里云VOD视频标题
    AuditStatusstring

    音/视频的终审结果。取值：

    • Normal：通过。
    • Blocked：屏蔽。
    		Normal
    Snapshotsarray

    视频截图 URL 数组。

    Snapshotstring

    视频截图 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****",...]
    StorageClassstring

    媒资存储类型。取值：

    • Standard：标准。
    • IA：媒资低频。
    • Archive：媒资归档。
    • ColdArchive：媒资冷归档。
    • SourceIA：源文件低频。
    • SourceArchive：源文件归档。
    • SourceColdArchive：源文件冷归档。
    • Changing：媒资存储类型变更中。
    • SourceChanging：源文件存储类型变更中。
    		Standard
    RestoreStatusstring

    媒资解冻状态。取值：

    • Processing：解冻中。
    • Success：解冻成功。
    • Failed：解冻失败。
    		Success
    RestoreExpirationstring

    媒资解冻有效期。

    		2023-03-30T10:14:14Z

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Video": {
    "StorageLocation": "out-201703232251****.oss-cn-shanghai.aliyuncs.com",
    "CreationTime": "2017-11-14T09:15:50Z",
    "Status": "Normal",
    "CateId": 0,
    "VideoId": "9b73864d75f1d231e9001cd5f8****",
    "DownloadSwitch": "on",
    "Tags": "标签1, 标签2",
    "ModificationTime": "2017-11-14T10:15:50Z",
    "RegionId": "cn-shanghai",
    "CustomMediaInfo": "{\"aaa\":\"test\"}",
    "CateName": "分类名",
    "Description": "阿里云VOD视频描述",
    "AppId": "app-****",
    "Size": 10897890,
    "CoverURL": "https://example.aliyundoc.com/****.jpg",
    "TemplateGroupId": "9ae2af636ca64835b0c10412f448****",
    "Duration": 135.6,
    "Title": "阿里云VOD视频标题",
    "AuditStatus": "Normal",
    "Snapshots": {
      "Snapshot": [
        "[\"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": ""
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-11-26OpenAPI 返回结构发生变更查看变更详情
    2024-05-23OpenAPI 返回结构发生变更查看变更详情
    2023-04-11OpenAPI 返回结构发生变更查看变更详情

    接口错误码

    下表列举了本接口特有的错误码。

    错误代码错误信息HTTP 状态码说明
    InvalidVideo.NotFoundThe video does not exist.404视频不存在。