Queries basic information about a video. The basic information includes the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags of the video.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetVideoInfo

The operation that you want to perform. Set the value to GetVideoInfo.

VideoId String Yes 9b73864d75f1*****d231e9001cd5f8

The ID of the video.

Response parameters

Parameter Type Example Description
RequestId String 25818875-5F78-4A*****F6-D7393642CA58

The ID of the request.

Video Struct

The information about the video.

AppId String app-****

The ID of the application.

AuditStatus String Normal

The review status of the video. Valid values:

  • Normal: pass
  • Blocked: failed
CateId Long 781111

The category ID of the video.

CateName String Category name

The category of the video.

CoverURL String https://image.example.com/****.jpg

The thumbnail URL of the video.

CreationTime String 2017-11-14T09:15:50Z

The time when the video was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

CustomMediaInfo String null

The information about the custom media asset.

Note This parameter has been deprecated. This parameter is no longer returned when you call the API.
Description String Video description in ApsaraVideo VOD

The description of the video.

Duration Float 135.6

The duration of the video. Unit: seconds.

ModificationTime String 2017-11-14T10:15:50Z

The time when the video was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

RegionId String cn-shanghai

The region ID of the Object Storage Service (OSS) bucket.

Size Long 10897890

The size of the source video file. Unit: byte.

Snapshots List ["http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52","http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52",...]

The URL array of video snapshots.

Status String Normal

The video status. Valid values:

  • Uploading: The video is being uploaded.
  • UploadFail: The video failed to be uploaded.
  • UploadSucc: The video has been uploaded.
  • Transcoding: The video is being transcoded.
  • TranscodeFail: The video failed to be transcoded.
  • Blocked: The video failed the review.
  • Normal: The video passed the review.
StorageLocation String out-201703232251****.oss-cn-shanghai.aliyuncs.com

The OSS bucket where the video is stored.

Tags String Tag 1,Tag 2

The tags of the video. Separate multiple tags with commas (,).

TemplateGroupId String 9ae2af636ca64835b0c10412f44891f2

The ID of the template group.

Title String Video title in ApsaraVideo VOD

The title of the video.

VideoId String 9b73864d75f1*****d231e9001cd5f8

The ID of the video.

Examples

Sample requests

https://vod.{ApiRegion}.aliyuncs.com/?Action=GetVideoInfo
&VideoId=9b73864d75f1*****d231e9001cd5f8
&<Common request parameters>

Sample success responses

XML format

<GetVideoInfoResponse>
  <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
  <Video>
        <Status>Normal</Status>
        <Description>Video description in ApsaraVideo VOD</Description>
        <VideoId>9b73864d75f1*****d231e9001cd5f8</VideoId>
        <Size>10897890</Size>
        <Title>Video title in ApsaraVideo VOD</Title>
        <ModificationTime>2017-11-14T10:15:50Z</ModificationTime>
        <Duration>135.6</Duration>
        <CateName>Category name</CateName>
        <CateId>781111</CateId>
        <AuditStatus>Normal</AuditStatus>
        <AppId>app-****</AppId>
        <CustomMediaInfo>{"aaa":"test"}</CustomMediaInfo>
        <CreationTime>2017-11-14T09:15:50Z</CreationTime>
        <CoverURL>https://image.example.com/****.jpg</CoverURL>
        <RegionId>cn-shanghai</RegionId>
        <StorageLocation>out-201703232251****.oss-cn-shanghai.aliyuncs.com</StorageLocation>
        <Snapshots>
              <Snapshot>["http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52","http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52",...]</Snapshot>
        </Snapshots>
        <Tags>Tag 1,Tag 2</Tags>
        <TemplateGroupId>9ae2af636ca64835b0c10412f44891f2</TemplateGroupId>
  </Video>
</GetVideoInfoResponse>

JSON format

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "Video": {
        "Status": "Normal",
        "Description": "Video description in ApsaraVideo VOD"
        "VideoId": "9b73864d75f1*****d231e9001cd5f8",
        "Size": "10897890",
        "Title": "Video title in ApsaraVideo VOD"
        "ModificationTime": "2017-11-14T10:15:50Z",
        "Duration": "135.6",
        "CateName": "Category name",
        "CateId": "781111",
        "AuditStatus": "Normal",
        "AppId": "app-****",
        "CustomMediaInfo": "{\"aaa\":\"test\"}",
        "CreationTime": "2017-11-14T09:15:50Z",
        "CoverURL": "https://image.example.com/****.jpg",
        "RegionId": "cn-shanghai",
        "StorageLocation": "out-201703232251****.oss-cn-shanghai.aliyuncs.com",
        "Snapshots": {
            "Snapshot": "[\"http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e273334f52\",\"http://image.example.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272434f52\",...]"
        },
        "Tags": "Tag 1,Tag 2",
        "TemplateGroupId": "9ae2af636ca64835b0c10412f44891f2"
    }
}

Error codes

For a list of error codes, visit the API Error Center.

Common errors

The following table describes the common errors that this operation can return.

Error code

Error message

HTTP status code

Description

InvalidVideo.NotFound

The video does not exist.

404

The error message is returned because the video does not exist.

SDK examples

We recommend that you use a server-side SDK to call this operation. For more information about the sample code that is used to call this operation in various languages, see the following topics: