GetVideoList-阿里云帮助中心

Gets information about video and audio files.

Operation description

Get information about up to the first 5,000 audio and video files based on the filter condition, such as the status or category ID of the file. We recommend that you set the StartTime and EndTime parameters to narrow down the time range and perform multiple queries to obtain data.

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

ice:GetVideoList

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CateId	integer	No	The ID of the category.	781111
Status	string	No	The status of the video. You can specify multiple video statuses and separate them with commas (,). Valid values: PrepareFail: The file is abnormal. 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. ProduceFail: The video failed to be produced. Normal: The video is normal. Uploading: The video is being uploaded. Preparing: The file is being generated. Blocked: The video is blocked. checking: The video is being reviewed. Valid values: PrepareFail : UploadFail : UploadSucc : Transcoding : TranscodeFail : ProduceFail : Normal : Uploading : Preparing : Blocked : Checking :	Uploading,Normal
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-01-11T12:00:00Z
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-01-11T12:59:00Z
SortBy	string	No	The sorting method of the results. Valid values: CreationTime:Desc (default): sorts results in reverse chronological order. CreationTime:Asc: sorts results in chronological order.	CreationTime:Asc
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 50.	20

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
Success	string	Indicates whether the request is successful. Valid values: true false	true
Code	string	The status code returned.	200
Total	integer	The total number of audio and video files that meet the conditions.	163
MediaList	array<object>	The information about the audio and video files.
	object	The information about the audio or video file.
StorageLocation	string	The storage address.	out-****.oss-cn-shanghai.aliyuncs.com
Status	string	The status of the video. Valid values: PrepareFail: The file is abnormal. 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. ProduceFail: The video failed to be produced. Normal: The video is normal. Uploading: The video is being uploaded. Preparing: The file is being generated. Blocked: The video is blocked. checking: The video is being reviewed. Valid values: PrepareFail : UploadFail : UploadSucc : Transcoding : TranscodeFail : ProduceFail : Normal : Uploading : Preparing : Blocked : Checking :	Normal
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-11-14T09:15:50Z
CateId	integer	The ID of the category.	3679
MediaId	string	The ID of the audio or video file.	1c6ce34007d571ed94667630a6bc****
Tags	string	The tags of the audio or video file.	Tag1, Tag2
ModificationTime	string	The 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-11-14T09:16:50Z
CateName	string	The name of the category.	Category1
Description	string	The description of the audio or video file.	Alibaba CloudVODVideo description
AppId	string	The ID of the application. Default value: app-1000000.	app-1000000
Size	integer	The size of the source file. Unit: bytes.	10897890
CoverUrl	string	The URL of the thumbnail.	http://example.aliyundoc.com/snapshot/**.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333**
Duration	number	The duration. Unit: seconds.	135.6
Title	string	The title of the audio or video file.	The best music player ever
Snapshots	array	The array of video snapshot URLs.
	string	The URL of the video snapshot.	http://example.aliyundoc.com/snapshot/**.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333**

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": "true",
  "Code": "200",
  "Total": 163,
  "MediaList": [
    {
      "StorageLocation": "out-****.oss-cn-shanghai.aliyuncs.com",
      "Status": "Normal",
      "CreationTime": "2017-11-14T09:15:50Z",
      "CateId": 3679,
      "MediaId": "1c6ce34007d571ed94667630a6bc****",
      "Tags": "Tag1, Tag2",
      "ModificationTime": "2017-11-14T09:16:50Z",
      "CateName": "Category1",
      "Description": "Alibaba CloudVODVideo description",
      "AppId": "app-1000000",
      "Size": 10897890,
      "CoverUrl": "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****",
      "Duration": 135.6,
      "Title": "The best music player ever",
      "Snapshots": [
        "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.