GetVideoList - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Retrieves a list of video information.

Operation description

This operation retrieves up to 5000 audio or video files based on filter conditions, such as video status or category ID. To retrieve data in batches, specify the StartTime and EndTime parameters. To query more files or traverse all media asset information, see Search for media assets.

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:GetVideoList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CateId	integer	No	The category ID. Obtain the ID in one of the following ways: Log on to the VOD console and choose Configuration Management > Media Asset Management > Category Management to view the category ID. The value of the CateId parameter that is returned after you call the AddCategory operation. The value of the CateId parameter that is returned after you call the GetCategories operation.	781111
Status	string	No	The status of the video. To retrieve videos in multiple statuses, separate the statuses with a comma (,). Valid values: Uploading: The video is being uploaded. UploadFail: The video failed to be uploaded. UploadSucc: The video is uploaded. Transcoding: The video is being transcoded. TranscodeFail: The video failed to be transcoded. Checking: The video is being reviewed. Blocked: The video is blocked. Normal: The video is in a normal state. ProduceFail: The video failed to be produced. For more information about each video status and its limits, see Status: Video status.	Uploading,Normal
PageNo	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The default value is 10. The maximum value is 100.	10
SortBy	string	No	The sorting rule for the query results. Valid values: CreationTime:Desc (default): Sorts the results by creation time in descending order. CreationTime:Asc: Sorts the results by creation time in ascending order.	CreationTime:Asc
StartTime	string	No	The beginning of the time range to query based on the creation time. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2017-01-11T12:00:00Z
EndTime	string	No	The end of the time range to query based on the creation time. The end time must be later than the start time. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2017-01-11T12:59:00Z
StorageLocation	string	No	The storage address of the audio or video file.	out-****.oss-cn-shanghai.aliyuncs.com
ReferenceIds	string	No	A list of one or more custom IDs. Separate multiple IDs with a comma (,). You can specify up to 20 IDs.	123-123,1234-1234

Response elements

Element	Type	Description	Example
	object	The response parameters.
Total	integer	The total number of audio or video files.	100
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
VideoList	object
Video	array<object>	A list of audio or video information. You can retrieve a maximum of 5,000 entries.
	array<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
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 is uploaded. Transcoding: The video is being transcoded. TranscodeFail: The video failed to be transcoded. Checking: The video is being reviewed. Blocked: The video is blocked. Normal: The video is in a normal state. ProduceFail: The video failed to be produced. For more information about each video status and its limits, see Status: Video status.	Normal
CreationTime	string	The time when the audio or video file was created. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2017-11-14T09:15:50Z
CateId	integer	The category ID.	781111
VideoId	string	The audio or video ID.	9ae2af636ca6c10412f44891fc****
Tags	string	The tags of the audio or video file. Multiple tags are separated by a comma (,).	标签1, 标签2
ModificationTime	string	The time when the video was last updated. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2017-11-14T09:16:50Z
CateName	string	The category name.	分类名称
Description	string	The description of the audio or video file.	阿里云VOD视频描述
AppId	string	The application ID. Default value: app-1000000.	app-1000000
Size	integer	The size of the source audio or video file. Unit: bytes.	10897890
CoverURL	string	The URL of the cover image for the audio or video file.	https://example.aliyundoc.com/****.jpg
Duration	number	The duration of the audio or video file. Unit: seconds.	135.6
Title	string	The title of the audio or video file.	阿里云VOD视频标题
Snapshots	object
Snapshot	array	An array of video snapshot URLs.
	string	The URL of a video snapshot. Note Snapshot data is returned only for videos that are processed by the video snapshot feature. Otherwise, this parameter is empty.	http://example.aliyundoc.com/snapshot/**.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333**
StorageClass	string	The storage class of the media asset. Valid values: Standard: Standard. IA: Infrequent Access. Archive: Archive. ColdArchive: Cold Archive. SourceIA: Infrequent Access for the source file. SourceArchive: Archive for the source file. SourceColdArchive: Cold Archive for the source file. 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 expiration time of the restored media asset.	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. It can contain only lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_). The ID must be 6 to 64 characters in length. The ID must be unique for each user.	123-123

Examples

Success response

JSON format

{
  "Total": 100,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "VideoList": {
    "Video": [
      {
        "StorageLocation": "out-****.oss-cn-shanghai.aliyuncs.com",
        "Status": "Normal",
        "CreationTime": "2017-11-14T09:15:50Z",
        "CateId": 781111,
        "VideoId": "9ae2af636ca6c10412f44891fc****",
        "Tags": "标签1, 标签2",
        "ModificationTime": "2017-11-14T09:16:50Z",
        "CateName": "分类名称",
        "Description": "阿里云VOD视频描述",
        "AppId": "app-1000000",
        "Size": 10897890,
        "CoverURL": "https://example.aliyundoc.com/****.jpg",
        "Duration": 135.6,
        "Title": "阿里云VOD视频标题",
        "Snapshots": {
          "Snapshot": [
            "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****"
          ]
        },
        "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.