Query AI jobs using ListAIJob - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries intelligent tagging or media fingerprint jobs. After you submit an intelligent tagging or media fingerprint job, the job is processed asynchronously. You can call this operation to query job information in real time.

Operation description

Regions that support media fingerprint: China (Beijing), China (Shanghai), and Singapore.
Regions that support intelligent tagging: China (Beijing) and China (Shanghai).

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	Yes	The list of job IDs. You can obtain the JobId from the PlayInfo struct returned by the GetPlayInfo operation. Note Separate multiple IDs with commas (,). You can specify up to 10 job IDs at a time.	a718a3a1e8bb42ee3bc88921e94**,aasdcsfg782740asd3,k2l3ibaskod98wrns9d**

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8233A0E4-E112-44*****58-2BCED1B88173
NonExistAIJobIds	object
String	array	The list of job IDs that do not exist.
	string	The list of job IDs that do not exist.	["aasdcsfg782740asd3**", "k2l3ibaskod98wrns9d**"]
AIJobList	object
AIJob	array<object>	The list of job information.
	object
CreationTime	string	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
Status	string	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
Type	string	The type of the job. Valid values: AIMediaDNA: video fingerprinting AIVideoTag: smart tagging	AIVideoTag
Data	string	The returned data. The value is a JSON string. For more information, see AITemplateConfig.	{"OrigASRData":{"AsrTextList":[{"EndTime":700,"StartTime":0,"Text":"Hmm.","ChannelId":0,"SpeechRate":85},{"EndTime":3750,"StartTime":1630,"Text":"Yes.","ChannelId":0,"SpeechRate":28},{"EndTime":5910,"StartTime":4020,"Text":"Never gets old.","ChannelId":0,"SpeechRate":95},{"EndTime":12750,"StartTime":10090,"Text":"Leave a message.","ChannelId":0,"SpeechRate":45},{"EndTime":25230,"StartTime":13590,"Text":"Hello, good afternoon.","ChannelId":0,"SpeechRate":20},{"EndTime":30000,"StartTime":28220,"Text":"Hmm.","ChannelId":0,"SpeechRate":33}],"Duration":"30016"}}
CompleteTime	string	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
JobId	string	The job ID.	a718a3a1e8bb42ee3bc88921e94****
Code	string	The error code. This parameter is returned if the value of Status is fail.	0
Message	string	The error message. This parameter is returned if the value of Status is fail.	OK
MediaId	string	The ID of the video file.	3D3D12340d9401fab46a0b847****

Examples

Success response

JSON format

{
  "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\":\"Hmm.\",\"ChannelId\":0,\"SpeechRate\":85},{\"EndTime\":3750,\"StartTime\":1630,\"Text\":\"Yes.\",\"ChannelId\":0,\"SpeechRate\":28},{\"EndTime\":5910,\"StartTime\":4020,\"Text\":\"Never gets old.\",\"ChannelId\":0,\"SpeechRate\":95},{\"EndTime\":12750,\"StartTime\":10090,\"Text\":\"Leave a message.\",\"ChannelId\":0,\"SpeechRate\":45},{\"EndTime\":25230,\"StartTime\":13590,\"Text\":\"Hello, good afternoon.\",\"ChannelId\":0,\"SpeechRate\":20},{\"EndTime\":30000,\"StartTime\":28220,\"Text\":\"Hmm.\",\"ChannelId\":0,\"SpeechRate\":33}],\"Duration\":\"30016\"}}",
        "CompleteTime": "2020-06-28T02:04:47Z",
        "JobId": "a718a3a1e8bb42ee3bc88921e94****",
        "Code": "0",
        "Message": "OK",
        "MediaId": "3D3D12340d9401fab46a0b847****"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.