All Products
Search
Document Center

ApsaraVideo VOD:ListAIJob

Last Updated:May 11, 2024

Queries AI jobs. After a job is submitted, ApsaraVideo VOD asynchronously processes the job. You can call this operation to query the job information in real time.

Operation description

  • Regions that support this operation: China (Beijing), China (Shanghai), and Singapore.
  • You can call this operation to query video fingerprinting jobs and smart tagging jobs.

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

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdsstringYes

The list of job IDs. You can obtain the job ID from the PlayInfo parameter in the response to the GetPlayInfo operation.

Note You can specify a maximum of 10 job IDs in a request. Separate multiple IDs with commas (,).
a718a3a1e8bb42ee3bc88921e94****,aasdcsfg782740asd3****,k2l3ibaskod98wrns9d****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

8233A0E4-E112-44*****58-2BCED1B88173
NonExistAIJobIdsarray

The IDs of the jobs that do not exist.

string

The IDs of the jobs that do not exist.

["aasdcsfg782740asd3****", "k2l3ibaskod98wrns9d****"]
AIJobListobject []

The list of jobs.

CreationTimestring

The time when the 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-06-28T02:04:32Z
Statusstring

The status of the job. Valid values:

  • success: The job is successful.
  • fail: The job failed.
  • init: The job is being initialized.
  • Processing: The job is in progress.
success
Typestring

The type of the job. Valid values:

  • AIMediaDNA: video fingerprinting
  • AIVideoTag: smart tagging
AIVideoTag
Datastring

The returned data. The value is a JSON string. For more information, see AITemplateConfig .

{"OrigASRData":{"AsrTextList":\[{"EndTime":700,"StartTime":0,"Text":"Yes.","ChannelId":0,"SpeechRate":85},{"EndTime":3750,"StartTime":1630,"Text":"No.","ChannelId":0,"SpeechRate":28},{"EndTime":5910,"StartTime":4020,"Text":"Of course.","ChannelId":0,"SpeechRate":95},{"EndTime":12750,"StartTime":10090,"Text":"Message.","ChannelId":0,"SpeechRate":45},{"EndTime":25230,"StartTime":13590,"Text":"Hello, good afternoon.","ChannelId":0,"SpeechRate":20},{"EndTime":30000,"StartTime":28220,"Text":"Yes.","ChannelId":0,"SpeechRate":33}],"Duration":"30016"}}
CompleteTimestring

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

2020-06-28T02:04:47Z
JobIdstring

The job ID.

a718a3a1e8bb42ee3bc88921e94****
Codestring

The error code. This parameter is returned if the value of Status is fail.

0
Messagestring

The error message. This parameter is returned if the value of Status is fail.

OK
MediaIdstring

The ID of the video file.

3D3D12340d9401fab46a0b847****

Examples

Sample success responses

JSONformat

{
  "RequestId": "8233A0E4-E112-44*****58-2BCED1B88173",
  "NonExistAIJobIds": {
    "String": [
      "[\"aasdcsfg782740asd3****\", \"k2l3ibaskod98wrns9d****\"]"
    ]
  },
  "AIJobList": {
    "AIJob": [
      {
        "CreationTime": "2020-06-28T02:04:32Z",
        "Status": "success",
        "Type": "AIVideoTag",
        "Data": "{\"OrigASRData\":{\"AsrTextList\":\\[{\"EndTime\":700,\"StartTime\":0,\"Text\":\"Yes.\",\"ChannelId\":0,\"SpeechRate\":85},{\"EndTime\":3750,\"StartTime\":1630,\"Text\":\"No.\",\"ChannelId\":0,\"SpeechRate\":28},{\"EndTime\":5910,\"StartTime\":4020,\"Text\":\"Of course.\",\"ChannelId\":0,\"SpeechRate\":95},{\"EndTime\":12750,\"StartTime\":10090,\"Text\":\"Message.\",\"ChannelId\":0,\"SpeechRate\":45},{\"EndTime\":25230,\"StartTime\":13590,\"Text\":\"Hello, good afternoon.\",\"ChannelId\":0,\"SpeechRate\":20},{\"EndTime\":30000,\"StartTime\":28220,\"Text\":\"Yes.\",\"ChannelId\":0,\"SpeechRate\":33}],\"Duration\":\"30016\"}}\n",
        "CompleteTime": "2020-06-28T02:04:47Z",
        "JobId": "a718a3a1e8bb42ee3bc88921e94****",
        "Code": "0",
        "Message": "OK",
        "MediaId": "3D3D12340d9401fab46a0b847****"
      }
    ]
  }
}

Error codes

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