首页 >视频点播 >API参考指南 >API目录 >媒资管理 >音视频管理 >GetVideoInfo - 获取单个音视频信息

GetVideoInfo - 获取单个音视频信息

调用GetVideoInfo获取单个音视频的基本信息。

接口说明

使用说明

  • 调用本接口通过音/视频ID来获取音视频的标题、描述、时长、封面URL、状态、创建时间、大小、截图、分类和标签等信息。
  • 音视频上传完成后,点播会对上传完成的音视频源文件进行分析,因此媒资信息是异步生成的。可通过设置音视频分析完成事件通知,当接收到音视频分析完成的事件通知后,再调用本接口获取音视频信息。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

音/视频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

视频状态。取值:

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

分类ID。

781111****
VideoIdstring

音/视频ID。

9b73864d75f1d231e9001cd5f8****
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****
Durationnumber

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

135.6
Titlestring

音/视频标题。

阿里云VOD视频标题
AuditStatusstring

视频审核综合状态。取值:

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

视频截图URL数组。

string

视频截图URL数组。

说明只有经过视频截图处理的视频,才会返回截图数据,否则返回为空。
["http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****","http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27243****",...]

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=GetVideoInfo
&VideoId=9b73864d75f1d231e9001cd5f8****
&公共请求参数

正常返回示例

JSON格式

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

XML格式

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

错误码

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

接口错误码

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

错误代码错误信息HTTP 状态码说明
InvalidVideo.NotFoundThe video does not exist.404视频不存在。
阿里云首页 视频点播 相关技术圈