Use ListAIImageInfo to query AI processing results of video images - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the AI image information of a specified video.

Operation description

Currently, this operation is supported in the following regions: China (Beijing) and China (Shanghai).
This operation can query AI image information of only a single video. Batch queries are not supported.

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

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 through 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, which is the value of the VideoId response parameter.	357a8748c5789d2726e6436aa****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D73420CD-D221-9122-5B8FA995A511****
AIImageInfoList	array<object>	The list of AI image files.
	object	The details of an AI image file.
CreationTime	string	The time when the data was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-10-15T03:30:03Z
AIImageInfoId	string	The ID of the image data information.	b89a6aabf1b6197ebd6fe6cf29****
FileURL	string	The URL of the AI image file.	http://example.aliyundoc.com/357a8748c5789d2726e6436aa**/image/ai/b0a7612554d6400013-0.gif?auth_key=1602745717-0-0-005ee05616c5925596d**
Version	string	The data version ID.	b547f3f0e199c3b457369f3cf****
VideoId	string	The video ID.	357a8748c5789d2726e6436aa****
JobId	string	The ID of the AI image processing job.	cf08a2c6e11ee1711b738b9067****
Score	string	The image score.	5.035636554444242
Format	string	The image format. Valid values: gif and png.	gif

Examples

Success response

JSON format

{
  "RequestId": "D73420CD-D221-9122-5B8FA995A511****",
  "AIImageInfoList": [
    {
      "CreationTime": "2020-10-15T03:30:03Z",
      "AIImageInfoId": "b89a6aabf1b6197ebd6fe6cf29****",
      "FileURL": "http://example.aliyundoc.com/357a8748c5789d2726e6436aa****/image/ai/b0a7612554d6400013-0****.gif?auth_key=1602745717-0-0-005ee05616c5925596d****",
      "Version": "b547f3f0e199c3b457369f3cf****",
      "VideoId": "357a8748c5789d2726e6436aa****",
      "JobId": "cf08a2c6e11ee1711b738b9067****",
      "Score": "5.035636554444242",
      "Format": "gif"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.