GetVideoInfo - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Call this operation to retrieve the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags of a single audio or video file by its ID.

Operation description

After an audio or video file is uploaded, VOD analyzes the source file and generates the media asset information asynchronously. You can configure event notifications for video and audio analysis completion. After you receive an event notification that indicates the analysis is complete, call this operation to retrieve the audio or video information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetVideoInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	No	The ID of the audio or video file. Specify only one ID. Obtain the ID in one of the following ways: For a video uploaded in the VOD console, log on to the console and choose Media Library > Audio/Video to view the ID. When you call the CreateUploadVideo operation to create an upload URL and credential, the value of the VideoId parameter in the response is the audio or video ID. After the audio or video file is uploaded, call the SearchMedia operation to query the ID. The value of the VideoId parameter in the response is the audio or video ID.	9b73864d75f1d231e9001cd5f8****
ReferenceId	string	No	The custom ID. The ID can contain lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The ID must be 6 to 64 characters in length and unique for each user.	123-123

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
Video	object	The information about the audio or video file.
StorageLocation	string	The storage address of the audio or video file.	out-201703232251****.oss-cn-shanghai.aliyuncs.com
CreationTime	string	The time when the audio or video file was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-11-14T09:15:50Z
Status	string	The status of the audio or video file. For more information about the available operations and limits for each state, see Status: the status of an audio or video file. Valid values: Uploading: The file is being uploaded. UploadFail: The file failed to be uploaded. UploadSucc: The file is uploaded. Transcoding: The file is being transcoded. TranscodeFail: The file failed to be transcoded. Blocked: The file is blocked. Normal: The file is in a normal state.	Normal
CateId	integer	The category ID.	781111****
VideoId	string	The ID of the audio or video file.	9b73864d75f1d231e9001cd5f8****
DownloadSwitch	string	The status of the offline download feature. When this feature is enabled, mobile client users can use ApsaraVideo Player to cache videos for offline viewing. For more information, see Configure offline download. Valid values: on: The offline download feature is enabled. off: The offline download feature is disabled.	on
Tags	string	The tags of the audio or video file. Multiple tags are separated by commas (,).	tag1, tag2
ModificationTime	string	The time when the audio or video file was last updated. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-11-14T10:15:50Z
RegionId	string	The region where the audio or video file is stored.	cn-shanghai
CustomMediaInfo	string	The custom media information. Note This parameter is deprecated. This parameter is not returned in API calls.	{"aaa":"test"}
CateName	string	The category name.	cate1
Description	string	The description of the audio or video file.	Alibaba Cloud VOD video description
AppId	string	The application ID.	app-****
Size	integer	The size of the source audio or video file. Unit: bytes.	10897890
CoverURL	string	The URL of the thumbnail.	https://example.aliyundoc.com/****.jpg
TemplateGroupId	string	The ID of the transcoding template group.	9ae2af636ca64835b0c10412f448****
Duration	number	The duration of the audio or video file. Unit: seconds.	135.6
Title	string	The title of the audio or video file.	Alibaba Cloud VOD Video Title
AuditStatus	string	The final review result of the audio or video file. Valid values: Normal: The file passed the review. Blocked: The file is blocked.	Normal
Snapshots	object
Snapshot	array	An array of video snapshot URLs.
	string	An array of video snapshot URLs. Note This operation returns only the thumbnail data of the video. To query the data of normal snapshots, sprites, original sprite images, and WebVTT snapshots that are captured using the snapshot feature, call the ListSnapshots operation.	["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	The storage class of the media asset. Valid values: Standard IA Archive ColdArchive SourceIA SourceArchive SourceColdArchive Changing: The storage class of the media asset is being changed. SourceChanging: The storage class of the source file is being changed.	Standard
RestoreStatus	string	The restored state of the media asset. Valid values: Processing: The media asset is being restored. Success: The media asset is restored. Failed: The media asset failed to be restored.	Success
RestoreExpiration	string	The expiration time of the restored media asset.	2023-03-30T10:14:14Z
UserData	string	The custom settings. The value is a JSON string. The settings include message callbacks and upload acceleration. For more information, see UserData.	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
ReferenceId	string	The custom ID. The ID can contain lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The ID must be 6 to 64 characters in length and unique for each user.	123-123

Examples

Success response

JSON format

{
  "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": "tag1, tag2",
    "ModificationTime": "2017-11-14T10:15:50Z",
    "RegionId": "cn-shanghai",
    "CustomMediaInfo": "{\"aaa\":\"test\"}",
    "CateName": "cate1",
    "Description": "Alibaba Cloud VOD video description",
    "AppId": "app-****",
    "Size": 10897890,
    "CoverURL": "https://example.aliyundoc.com/****.jpg",
    "TemplateGroupId": "9ae2af636ca64835b0c10412f448****",
    "Duration": 135.6,
    "Title": "Alibaba Cloud VOD Video Title",
    "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": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"},\"Extend\":{\"localId\":\"*****\",\"test\":\"www\"}}",
    "ReferenceId": "123-123"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.