DocsICP FilingConsole
Documentation
Home Page Intelligent Media Services Developer Reference API Reference API catalog Media asset management Media asset search Search function Basic search GetVideoList

GetVideoList

Updated at:
Copy as MD
Product
My Favorites

Retrieves a list of video information.

Operation description

This operation retrieves up to 5,000 audio and video files that meet specified filter conditions, such as video status and category ID. Specify StartTime and EndTime to retrieve data in batches.

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

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
CateId

integer

No

The category ID.

781111
Status

string

No

The video status. Separate multiple statuses with commas (,).

Valid values:

  • PrepareFail :

    File exception.

  • UploadFail :

    Upload failed.

  • UploadSucc :

    Upload completed.

  • Transcoding :

    Transcoding.

  • TranscodeFail :

    Transcoding failed.

  • ProduceFail :

    Production failed.

  • Normal :

    Normal.

  • Uploading :

    Uploading.

  • Preparing :

    File generation in progress.

  • Blocked :

    Blocked.

  • Checking :

    Reviewing.

Uploading,Normal
StartTime

string

No

The start time of the creation time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and must be in UTC.

2017-01-11T12:00:00Z
EndTime

string

No

The end time of the creation time. The end time must be later than the start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and must be in UTC.

2017-01-11T12:59:00Z
SortBy

string

No

The sort order of the query results. Valid values:

  • CreationTime:Desc: Sorts the results by creation time in descending order. This is the default value.

  • CreationTime:Asc: Sorts the results by creation time in ascending order.

CreationTime:Asc
PageNo

integer

No

The current 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 response schema.

RequestId

string

The ID of the request.

******11-DB8D-4A9A-875B-275798******
Success

string

Indicates whether the request is successful. Valid values:

  • true: The request is successful.

  • false: The request fails.

true
Code

string

The return code.

200
Total

integer

The total number of media assets that meet the filter conditions.

163
MediaList

array<object>

The list of media assets.

object

The list of media assets.

StorageLocation

string

The storage location.

out-****.oss-cn-shanghai.aliyuncs.com
Status

string

The video status.

Valid values:

  • PrepareFail :

    File exception.

  • UploadFail :

    Upload failed.

  • UploadSucc :

    Upload successful.

  • Transcoding :

    Transcoding.

  • TranscodeFail :

    Transcoding failed.

  • ProduceFail :

    Production failed.

  • Normal :

    Normal.

  • Uploading :

    Uploading.

  • Preparing :

    File generation in progress.

  • Blocked :

    Blocked.

  • Checking :

    Reviewing.

Normal
CreationTime

string

The creation time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and must be in UTC.

2017-11-14T09:15:50Z
CateId

integer

The category ID.

3679
MediaId

string

The media asset ID.

1c6ce34007d571ed94667630a6bc****
Tags

string

The list of tags.

Tag1, Tag2
ModificationTime

string

The update time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and must be in UTC.

2017-11-14T09:16:50Z
CateName

string

The category name.

Cate1
Description

string

The description.

Alibaba Cloud VOD video description
AppId

string

The application ID. Default value: app-1000000.

app-1000000
Size

integer

The size of the source file. Unit: bytes.

10897890
CoverUrl

string

The URL of the cover image.

http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****
Duration

number

The duration. Unit: seconds.

135.6
Title

string

The title.

The greatest music player in history
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": "Cate1",
      "Description": "Alibaba Cloud VOD video description",
      "AppId": "app-1000000",
      "Size": 10897890,
      "CoverUrl": "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****",
      "Duration": 135.6,
      "Title": "The greatest music player in history",
      "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.

Previous：SearchMediaNext：Face search