ListJobInfo API Overview for Historical Task Retrieval - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Usage notes

To query detailed task information, call the GetJobDetail operation.
This operation only supports querying asynchronous task data within the last 6 months. Supported task types: transcoding tasks, snapshot tasks, and AI tasks.

QPS limit

The single-user QPS limit for this operation is 15 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limit.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	Yes	The media asset ID.	30e5d7**********bd900764de7c0102
JobType	string	Yes	The task type. Valid values: transcode snapshot ai	transcode

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6708D849-F109-1A6C-AC91-************
MediaId	string	The media asset ID.	30e5d7**********bd900764de7c0102
JobType	string	The task type. Valid values: transcode snapshot ai	transcode
JobInfoList	array<object>	The historical task list within the last 6 months.
	object
JobId	string	The task ID.	5c9dff751ba**********59d50a967f5
Status	string	The task status.	TranscodeSuccess
UserId	integer	The ID of the user who initiated the task.	139109*****84930
CreateTime	string	The time when the task was created, in UTC. Format: YYYY-MM-DDTHH:MM:SSZ.	2024-10-14T07:39:25Z
CompleteTime	string	The time when the task was completed.	2024-10-14T07:39:34Z

Examples

Success response

JSON format

{
  "RequestId": "6708D849-F109-1A6C-AC91-************\n",
  "MediaId": "30e5d7**********bd900764de7c0102\n",
  "JobType": "transcode",
  "JobInfoList": [
    {
      "JobId": "5c9dff751ba**********59d50a967f5",
      "Status": "TranscodeSuccess",
      "UserId": 0,
      "CreateTime": "2024-10-14T07:39:25Z\n",
      "CompleteTime": "2024-10-14T07:39:34Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.