All Products
Search
Document Center

ApsaraVideo VOD:ListDynamicImage

Last Updated:Dec 19, 2024

Queries the information about animated images of a video based on the video ID.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vod:ListDynamicImagelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VideoIdstringYes

The ID of the video.

2e114f1100590c3193918fd449a****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

570189B6-572E-4953-13B4278EE0D8****
DynamicImageListarray<object>

The list of animated stickers.

DynamicImageobject

The list of animated stickers.

CreationTimestring

The time when the animated sticker was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2020-07-28T02:01:06Z
FileURLstring

The URL of the animated sticker file.

https://example.aliyundoc.com/2e114f110059*****0c3193918fd449a/image/dynamic/2b4e51df60*****323ef43d6e336ecf.webp?auth_key=1597296785-0-0-4a48e85*****bd2bb358e0b3cade
VideoIdstring

The ID of the video.

2e114f1100590c3193918fd449a****
Widthstring

The width of the animated sticker. Unit: pixel.

640
JobIdstring

The job ID for creating the animated sticker.

2bf4390af9e5491c09cc720ad****
Heightstring

The height of the animated sticker. Unit: pixel.

360
Fpsstring

The frame rate of the animated sticker. Unit: frames per second.

10
Durationstring

The duration of the animated sticker. Unit: seconds.

2
Formatstring

The format of the animated sticker. Valid values: gif and webp.

webp
DynamicImageIdstring

The ID of the animated sticker.

2b4e51df60323ef43d6e336ecf****
FileSizestring

The size of the animated sticker file. Unit: byte.

119866

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.