Batch retrieve information for audio and video files using GetVideoInfos - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the information about multiple audio and video files at a time by audio or video ID, including the title, description, duration, thumbnail URL, status, creation time, size, snapshots, category, and tags.

Operation description

You can retrieve information about up to 20 audio and video files at a time.
After an audio or video file is uploaded, ApsaraVideo VOD analyzes the uploaded source file. Therefore, media asset information is generated asynchronously. You can configure the AudioVideoAnalysisComplete event notification. After you receive the AudioVideoAnalysisComplete event notification, call this operation to retrieve the audio and 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	The list of audio or video IDs. Separate multiple IDs with commas (,). You can specify a maximum of 20 IDs. You can obtain the audio or video ID by using the following methods: If the video is uploaded by using the ApsaraVideo VOD console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the audio or video ID. Obtain the audio or video ID from the value of the VideoId response parameter when you call the CreateUploadVideo operation to obtain the upload URL and credential. After the audio or video file is uploaded, you can call the SearchMedia operation to query the audio or video ID, which is the value of the VideoId response parameter.	7753d144efd8e649c6c45fe0579**,7753d144efd74d6c45fe0570**
ReferenceIds	string	No	The list of custom IDs. Separate multiple IDs with commas (,). You can specify a maximum of 20 IDs.	123-123,1234-1234

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
NonExistVideoIds	array	The list of audio or video IDs that do not exist.
	string	The list of audio or video IDs that do not exist.	["7753d144efd8e649c6c45fe0579****"]
NonExistReferenceIds	array	The list of custom IDs that do not exist.
	string	The list of custom IDs that do not exist.	123-123
VideoList	array<object>	The information about the audio and video files.
	object	The details of the audio or video file.
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 time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-06-26T05:38:48Z
Status	string	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 is blocked. Normal: The video is in a normal state.	Normal
CateId	integer	The category ID.	781111****
VideoId	string	The audio or video ID.	7753d144efd74d6c45fe0570****
DownloadSwitch	string	The status of the offline download switch. If the offline download feature is enabled, mobile users can cache videos to their local devices for offline viewing by using ApsaraVideo Player. For more information, see Offline download. Valid values: on: enabled. Offline download is allowed. off: disabled. Offline download is not allowed.	on
Tags	string	The tags of the audio or video file. Multiple tags are separated by commas (,).	tag1, tag2
ModificationTime	string	The last time when the audio or video file was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed 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 audio or video source file. Unit: bytes.	453
CoverURL	string	The thumbnail URL of the audio or video file.	https://example.aliyundoc.com/****.jpg
TemplateGroupId	string	The transcoding template group ID.	b4039216985f4312a5382a4ed****
Duration	number	The duration of the audio or video file. Unit: seconds.	120
Title	string	The title of the audio or video file.	Alibaba Cloud VOD Video Title
Snapshots	array	The array of video snapshot URLs.
	string	The array of video snapshot URLs. Note This operation returns only the thumbnail snapshot data of the video. To query the snapshot data of normal snapshots, sprite snapshots, sprite original images, and WebVTT snapshots captured by 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: media asset Infrequent Access. Archive: media asset Archive. ColdArchive: media asset Cold Archive. SourceIA: source file Infrequent Access. SourceArchive: source file Archive. SourceColdArchive: source file Cold Archive. Changing: the media asset storage class is being changed. SourceChanging: the source file storage class 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 expiration time of the media asset restoration.	2023-03-30T10:14:14Z
UserData	string	The custom settings. The value 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 value can contain only lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_), and must be 6 to 64 characters in length. The value is unique at the user level.	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.