All Products
Search
Document Center

:GetJobDetail

Last Updated:Mar 21, 2025

Queries the details of an asynchronous task based on jobId.

Operation description


You can call this operation to query only asynchronous tasks of the last six months. The types of tasks that you can query include transcoding tasks, snapshot tasks, and AI tasks.

QPS limit

You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:GetJobDetailget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the task.

5c9dff***************59d50a967f5
JobTypestringYes

The task type. Valid values:

  • transcode
  • snapshot
  • ai
transcode

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

6708D849-F109-1A6C-AC91-************
JobTypestring

The type of the task. Valid values:

transcode
TranscodeJobDetailobject

The details of the transcoding task. This parameter takes effect only when the jobType parameter is set to Transcode.

JobIdstring

The ID of the task.

2dc1634e**********3f1d22d1a0174e
UserIdlong

The ID of the user who submitted the task.

139109*****84930
VideoIdstring

The ID of the media asset.

30e5d7**********bd900764de7c0102
Statusstring

The status of the task. Valid values:

  • Submitted
  • Transcoding
  • TranscodeSuccess
  • TranscodeFail
  • TranscodeCancelled
TranscodeSuccess
TemplateIdstring

The ID of the template.

dbfaaec9e**********bf0b81219244c
Definitionstring

The definition.

HD
CreateTimestring

The time when the task was created. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time is displayed in UTC.

2024-10-14T07:39:25Z
CompleteTimestring

The time when the task was complete.

2024-10-14T07:39:34Z
SnapshotJobDetailobject

The details of the snapshot task. This parameter takes effect only when the jobType parameter is set to Snapshot.

JobIdstring

The ID of the task.

63df12s0**********4hdq249t82kr91
UserIdlong

The ID of the user who submitted the task.

139109*****84930
VideoIdstring

The ID of the media asset.

30e5d7**********bd900764de7c0102
Statusstring

The status of the task. Valid values:

  • Processing
  • Fail
  • Success
Success
Triggerstring

The trigger mode. Valid values:

  • Auto
  • Manual
Auto
NormalConfigstring

Configuration of normal snapshots.

{"inl":0,"num":32,"tm":5,"wd":"352","ft":"normal","hg":"640"}
SpriteConfigstring

The sprite configuration.

{"pad":"0","lines":"10","mgin":"0","cols":"10","ikcp":"false","hg":"68"}
CreateTimestring

The time when the task was created. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time is displayed in UTC.

2024-10-14T07:39:25Z
CompleteTimestring

The time when the task was complete.

2024-10-14T07:39:45Z
AIJobDetailobject

The details of the AI task. This parameter takes effect only when the TaskType parameter is set to AI.

JobIdstring

The ID of the task.

5c9dff751ba**********59d50a967f5
UserIdlong

The ID of the user who submitted the task.

139109*****84930
MediaIdstring

The ID of the media asset.

30e5d7**********bd900764de7c0102
JobTypestring

The type of the AI task.

AIVideoCensor
Statusstring

The status of the task. Valid values:

  • reserved
  • init
  • success
  • fail
  • processing
  • analysing
success
Triggerstring

The trigger mode. Valid values:

  • Auto
  • Manual
Auto
TemplateConfigstring

The template configuration.

{"AuditRange":["video","image-cover","text-title"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"no"}
CreateTimestring

The time when the task was created. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time is displayed in UTC.

2024-10-14T07:39:25Z
CompleteTimestring

The end time of the task.

2024-10-14T07:39:46Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "6708D849-F109-1A6C-AC91-************",
  "JobType": "transcode",
  "TranscodeJobDetail": {
    "JobId": "2dc1634e**********3f1d22d1a0174e",
    "UserId": 0,
    "VideoId": "30e5d7**********bd900764de7c0102",
    "Status": "TranscodeSuccess",
    "TemplateId": "dbfaaec9e**********bf0b81219244c",
    "Definition": "HD",
    "CreateTime": "2024-10-14T07:39:25Z",
    "CompleteTime": "2024-10-14T07:39:34Z"
  },
  "SnapshotJobDetail": {
    "JobId": "63df12s0**********4hdq249t82kr91",
    "UserId": 0,
    "VideoId": "30e5d7**********bd900764de7c0102",
    "Status": "Success",
    "Trigger": "Auto",
    "NormalConfig": "{\"inl\":0,\"num\":32,\"tm\":5,\"wd\":\"352\",\"ft\":\"normal\",\"hg\":\"640\"}",
    "SpriteConfig": "{\"pad\":\"0\",\"lines\":\"10\",\"mgin\":\"0\",\"cols\":\"10\",\"ikcp\":\"false\",\"hg\":\"68\"}",
    "CreateTime": "2024-10-14T07:39:25Z",
    "CompleteTime": "2024-10-14T07:39:45Z"
  },
  "AIJobDetail": {
    "JobId": "5c9dff751ba**********59d50a967f5",
    "UserId": 0,
    "MediaId": "30e5d7**********bd900764de7c0102",
    "JobType": "AIVideoCensor",
    "Status": "success",
    "Trigger": "Auto",
    "TemplateConfig": "{\"AuditRange\":[\"video\",\"image-cover\",\"text-title\"],\"AuditContent\":[\"screen\"],\"AuditItem\":[\"terrorism\",\"porn\"],\"AuditAutoBlock\":\"no\"}",
    "CreateTime": "2024-10-14T07:39:25Z",
    "CompleteTime": "2024-10-14T07:39:46Z\n"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history