GetVideoInfos - ApsaraVideo VOD - Alibaba Cloud Documentation Center

You can call this operation to retrieve information about multiple audio or video files in a batch using their IDs. The information includes the title, description, duration, thumbnail URL, status, creation time, size, snapshots, categorization, and tags.

Operation description

You can retrieve information for a maximum of 20 audio or video files in a single call.
After you upload an audio or video file, VOD analyzes the source file. The media asset information is generated asynchronously. You can set an event notification for the VideoAnalysisComplete event. After you receive the notification, you can 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:GetVideoInfos

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoIds	string	No	A list of audio or video IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs is supported. You can obtain audio or video IDs in the following ways: For videos uploaded using the console, log on to the VOD console and choose Media Library > Audio/Video to view the audio or video IDs. When you call the CreateUploadVideo operation to obtain an upload URL and credentials, the audio or video ID is the value of the VideoId response parameter. After you upload an audio or video file, call the SearchMedia operation to query the audio or video ID. The ID is the value of the VideoId response parameter.	7753d144efd8e649c6c45fe0579**,7753d144efd74d6c45fe0570**
ReferenceIds	string	No	A list of one or more custom IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs is supported.	123-123,1234-1234

Response elements

Element	Type	Description	Example
	object	The response that is returned.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
NonExistVideoIds	array	A list of audio or video IDs that do not exist.
	string	A list of audio or video IDs that do not exist.	["7753d144efd8e649c6c45fe0579****"]
NonExistReferenceIds	array	A list of custom IDs that do not exist.
	string	A list of custom IDs that do not exist.	123-123
VideoList	array<object>	The list of audio or video information.
	object	The details of the audio or video information.
StorageLocation	string	The storage address of the audio or video file.	out-****.oss-cn-shanghai.aliyuncs.com
CreationTime	string	The time when the audio or video file was created. The format is yyyy-MM-ddTHH:mm:ssZ in UTC.	2017-06-26T05:38:48Z
Status	string	The status of the video. Valid values: Uploading: The video is being uploaded. UploadFail: The video failed to be uploaded. UploadSucc: The video was successfully uploaded. Transcoding: The video is being transcoded. TranscodeFail: The video failed to be transcoded. Blocked: The video is blocked. Normal: The video is available.	Normal
CateId	integer	The category ID.	781111****
VideoId	string	The audio or video ID.	7753d144efd74d6c45fe0570****
DownloadSwitch	string	The status of the offline download feature. If this feature is enabled, users of mobile devices can use ApsaraVideo Player to cache videos for offline viewing. For more information, see Offline download. Valid values: on: Offline download is enabled. off: Offline download is disabled.	on
Tags	string	The tags of the audio or video file. Separate multiple tags with commas (,).	tag1, tag2
ModificationTime	string	The time when the audio or video file was last updated. The format is yyyy-MM-ddTHH:mm:ssZ in UTC.	2017-06-26T06:38:48Z
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, in bytes.	453
CoverURL	string	The thumbnail URL of the audio or video file.	https://example.aliyundoc.com/****.jpg
TemplateGroupId	string	The ID of the transcoding template group.	b4039216985f4312a5382a4ed****
Duration	number	The duration of the audio or video file, in seconds.	120
Title	string	The title of the audio or video file.	Alibaba Cloud VOD Video Title
Snapshots	array	An array of video snapshot URLs.
	string	An array of video snapshot URLs. Note This operation returns only the thumbnail snapshot data of the video. To query data for normal snapshots, sprites, original sprite images, and WebVTT snapshots that are captured using the video 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: Standard IA: Infrequent Access Archive: Archive ColdArchive: Cold Archive SourceIA: The storage class of the source file is Infrequent Access. SourceArchive: The storage class of the source file is Archive. SourceColdArchive: The storage class of the source file is Cold Archive. 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 restoration status 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 time when the restored media asset expires.	2023-03-30T10:14:14Z
UserData	string	Custom settings. This is a JSON string that supports settings such as 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 only 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****",
  "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": "tag1, tag2",
      "ModificationTime": "2017-06-26T06:38:48Z",
      "CateName": "cate1",
      "Description": "Alibaba Cloud VOD video description",
      "AppId": "app-****",
      "Size": 453,
      "CoverURL": "https://example.aliyundoc.com/****.jpg",
      "TemplateGroupId": "b4039216985f4312a5382a4ed****",
      "Duration": 120,
      "Title": "Alibaba Cloud VOD Video Title",
      "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.