All Products
Search
Document Center

ApsaraVideo VOD:ListAIImageInfo

Last Updated:May 11, 2024

Queries the AI processing results about the images of a specified video.

Operation description

  • Regions that support this operation: China (Beijing) and China (Shanghai).
  • You can call this operation to query AI processing results about images of a specified video. Images of different videos cannot be queried in one request.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListAIImageInfoList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VideoIdstringYes

The ID of the video. You can use one of the following methods to obtain the ID:

  • Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Media Files > Audio/Video. On the Video and Audio page, view the ID of the audio or video file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console.
  • Obtain the value of VideoId from the response to the CreateUploadVideo operation that you call to upload media files.
  • Obtain the value of VideoId from the response to the SearchMedia operation after you upload media files.
357a8748c5789d2726e6436aa****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

D73420CD-D221-9122-5B8FA995A511****
AIImageInfoListobject []

The image files that are uploaded for AI processing.

CreationTimestring

The time when the file 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
AIImageInfoIdstring

The ID of the image information.

b89a6aabf1b6197ebd6fe6cf29****
FileURLstring

The URL of the image file.

http://example.aliyundoc.com/357a8748c5789d2726e6436aa****/image/ai/b0a7612554d6400013-0****.gif?auth_key=1602745717-0-0-005ee05616c5925596d****
Versionstring

The data version ID.

b547f3f0e199c3b457369f3cf****
VideoIdstring

The ID of the video.

357a8748c5789d2726e6436aa****
JobIdstring

The ID of the image AI processing job.

cf08a2c6e11ee1711b738b9067****
Scorestring

The score of the image.

5.035636554444242
Formatstring

The format of the image. Valid values: gif and png.

gif

Examples

Sample success responses

JSONformat

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

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