GetJobDetail - 获取任务详情 - 视频点播

调用本接口根据jobId查询异步任务详情。

接口说明

使用说明

本接口仅支持查询 6 个月内的异步任务数据。可查询的任务类型：转码任务，截图任务，AI 任务。

QPS 限制

本接口的单用户 QPS 限制为 15 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vod:GetJobDetail	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
JobId	string	是	任务 ID	5c9dff***************59d50a967f5
JobType	string	是	任务类型，取值： transcode snapshot ai	transcode

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求唯一标识	6708D849-F109-1A6C-AC91-************
JobType	string	任务类型	transcode
TranscodeJobDetail	object	转码任务详细信息，仅当 jobType 为 Transcode，该字段有值。
JobId	string	任务 ID	2dc1634e**********3f1d22d1a0174e
UserId	long	发起该任务的用户 ID	139109*****84930
VideoId	string	媒资 ID	30e5d7**********bd900764de7c0102
Status	string	任务状态，取值： Submitted，已提交 Transcoding，转码中 TranscodeSuccess，转码成功 TranscodeFail，转码失败 TranscodeCancelled，取消转码	TranscodeSuccess
TemplateId	string	模板 ID	dbfaaec9e**********bf0b81219244c
Definition	string	清晰度	HD
CreateTime	string	任务创建时间，UTC 格式，YYYY-MM-DDTHH:MM:SSZ	2024-10-14T07:39:25Z
CompleteTime	string	任务完成时间	2024-10-14T07:39:34Z
SnapshotJobDetail	object	截图任务详细信息，仅当 jobType 为 Snapshot，该字段有值
JobId	string	任务 ID	63df12s0**********4hdq249t82kr91
UserId	long	发起该任务的用户 ID	139109*****84930
VideoId	string	媒资 ID	30e5d7**********bd900764de7c0102
Status	string	任务状态，取值： Processing，处理中 Fail，任务失败 Success，任务成功	Success
Trigger	string	触发方式，取值： Auto，工作流自动触发 Manual，手动提交任务	Auto
NormalConfig	string	普通截图配置	{"inl":0,"num":32,"tm":5,"wd":"352","ft":"normal","hg":"640"}
SpriteConfig	string	雪碧图配置	{"pad":"0","lines":"10","mgin":"0","cols":"10","ikcp":"false","hg":"68"}
CreateTime	string	任务创建时间，UTC 格式，YYYY-MM-DDTHH:MM:SSZ	2024-10-14T07:39:25Z
CompleteTime	string	任务完成时间	2024-10-14T07:39:45Z
AIJobDetail	object	AI 任务详细信息，仅当 TaskType 为 AI，该字段有值
JobId	string	任务 ID	5c9dff751ba**********59d50a967f5
UserId	long	发起该任务的用户 ID	139109*****84930
MediaId	string	媒资 ID	30e5d7**********bd900764de7c0102
JobType	string	AI 任务类型	AIVideoCensor
Status	string	任务状态，取值： reserved，已提交 init，已启动 success，执行成功 fail，执行失败 processing，处理中 analysing，分析中	success
Trigger	string	触发方式，取值： Auto，工作流自动触发 Manual，手动提交任务	Auto
TemplateConfig	string	模板配置	{"AuditRange":["video","image-cover","text-title"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"no"}
CreateTime	string	任务创建时间，UTC 格式，YYYY-MM-DDTHH:MM:SSZ	2024-10-14T07:39:25Z
CompleteTime	string	任务结束时间	2024-10-14T07:39:46Z

示例

正常返回示例

JSON格式

{
  "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"
  }
}

错误码

访问错误中心查看更多错误码。