Query animated images of a video using ListDynamicImage - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the list of animated images for a video by video ID.

Operation description

Usage notes

After animated image capturing for a video is complete, call this operation to obtain the animated image information of the video.
Animated image tasks can be initiated by calling an API operation (SubmitDynamicImageJob) or by using the console. For more information, see Animated images.

QPS limit

The QPS limit for a single user for this operation is 100 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limits.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The video ID. You can obtain the video ID by using one of the following methods: For videos uploaded by using the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID. Obtain the 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 video is uploaded, call the SearchMedia operation to query the video ID. The video ID is the value of the VideoId response parameter.	2e114f1100590c3193918fd449a****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	570189B6-572E-4953-13B4278EE0D8****
DynamicImageList	array<object>	The animated image results.
	object	The animated image details.
CreationTime	string	The time when the animated image was created. The time follows the format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2020-07-28T02:01:06Z
FileURL	string	The URL of the animated image file.	https://example.aliyundoc.com/2e114f110059***0c3193918fd449a/image/dynamic/2b4e51df60*323ef43d6e336ecf.webp?auth_key=1597296785-0-0-4a48e85***bd2bb358e0b3cade
VideoId	string	The video ID.	2e114f1100590c3193918fd449a****
Width	string	The width of the animated image. Unit: px.	640
JobId	string	The animated image job ID.	2bf4390af9e5491c09cc720ad****
Height	string	The height of the animated image. Unit: px.	360
Fps	string	The frame rate of the animated image. Unit: frames per second.	10
Duration	string	The duration of the animated image. Unit: seconds.	2
Format	string	The format of the animated image. Valid values: gif webp	webp
DynamicImageId	string	The animated image ID.	2b4e51df60323ef43d6e336ecf****
FileSize	string	The size of the animated image file. Unit: bytes.	119866

Examples

Success response

JSON format

{
  "RequestId": "570189B6-572E-4953-13B4278EE0D8****",
  "DynamicImageList": [
    {
      "CreationTime": "2020-07-28T02:01:06Z",
      "FileURL": "https://example.aliyundoc.com/2e114f110059*****0c3193918fd449a/image/dynamic/2b4e51df60*****323ef43d6e336ecf.webp?auth_key=1597296785-0-0-4a48e85*****bd2bb358e0b3cade",
      "VideoId": "2e114f1100590c3193918fd449a****",
      "Width": "640",
      "JobId": "2bf4390af9e5491c09cc720ad****",
      "Height": "360",
      "Fps": "10",
      "Duration": "2",
      "Format": "webp",
      "DynamicImageId": "2b4e51df60323ef43d6e336ecf****",
      "FileSize": "119866"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.