All Products
Search
Document Center

ApsaraVideo VOD:GetAIImageJobs

Last Updated:Jan 29, 2024

Queries jobs of image AI processing.

Operation description

  • Regions that support this operation: China (Beijing) and China (Shanghai).
  • Call the SubmitAIImageJob operation to submit image AI processing jobs before you call this operation to query image AI processing jobs.
  • You can query a maximum of 10 jobs of image AI processing 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:GetAIImageJobsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdsstringYes

The ID of the image AI processing job. You can obtain the value of JobId from the response to the SubmitAIImageJob operation.

  • You can specify a maximum of 10 IDs.
  • Separate multiple IDs with commas (,).
cf08a2c6e11e*****de1711b738b9067

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

7721B494-1F78-4E*****E8-A7CEE7315BFA
AIImageJobListobject []

The image AI processing jobs.

Statusstring

The status of the job. Valid values:

  • success
  • fail
success
CreationTimestring

The time when the image AI processing job 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
AIImageResultstring

The Object Storage Service (OSS) URL of the image file.

Note This parameter does not include the complete authentication information. To obtain the authentication information, you must generate a signed URL. Alternatively, you can call the ListAIImageInfo operation to obtain the image information.
[{"Score":5.035636554444242,"Url":"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif"}]
VideoIdstring

The ID of the video.

357a8748c577*****789d2726e6436aa
JobIdstring

The ID of the image AI processing job.

cf08a2c6e11e*****de1711b738b9067
UserDatastring

The user data.

  • The value must be a JSON string.
  • The MessageCallback or Extend parameter is returned.
  • The value contains a maximum of 512 bytes.

For more information, see the "UserData: specifies the custom configurations for media upload" section of the Request parameters topic.

{"Extend":{"localId":"****","test":"www"}}
Codestring

The error code.

Success
Messagestring

The error message.

success
TemplateConfigstring

The configurations of the AI template that was used to submit the job.

{"Format":"gif","SetDefaultCover":"true"}
TemplateIdstring

The ID of the AI template.

5a86a00f15194*****d7fe7de1b4a173

Examples

Sample success responses

JSONformat

{
  "RequestId": "7721B494-1F78-4E*****E8-A7CEE7315BFA",
  "AIImageJobList": [
    {
      "Status": "success",
      "CreationTime": "2020-10-15T03:30:03Z",
      "AIImageResult": "[{\"Score\":5.035636554444242,\"Url\":\"http://outin-*****.oss-cn-shanghai.aliyuncs.com/357a8748c577*****789d2726e6436aa/image/ai/b0a7612554d*****5cbe3-00001.gif\"}]",
      "VideoId": "357a8748c577*****789d2726e6436aa",
      "JobId": "cf08a2c6e11e*****de1711b738b9067",
      "UserData": "{\"Extend\":{\"localId\":\"****\",\"test\":\"www\"}}",
      "Code": "Success",
      "Message": "success",
      "TemplateConfig": "{\"Format\":\"gif\",\"SetDefaultCover\":\"true\"}",
      "TemplateId": "5a86a00f15194*****d7fe7de1b4a173"
    }
  ]
}

Error codes

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