GetJobDetail - ApsaraVideo VOD: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma tarefa assíncrona pelo ID do job.

Descrição da operação

Notas de uso

Esta operação suporta apenas a consulta de dados de tarefas assíncronas dos últimos 6 meses. Os tipos de tarefas que podem ser consultados incluem tarefas de transcodificação, tarefas de snapshot, tarefas de IA e tarefas de workflow.

Limite de QPS

O limite de QPS para um único usuário que chama esta operação é de 15 consultas por segundo. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Faça chamadas de API em uma frequência razoável. Para mais informações, consulte Limites de QPS.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

vod:GetJobDetail

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
JobId	string	Sim	O ID do job. Nota: Para consultar uma tarefa de transcodificação por TaskId, consulte GetTranscodeTask.	5c9dff***************59d50a967f5
JobType	string	Sim	O tipo de tarefa. Valores válidos: transcode snapshot ai workflow	transcode

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID exclusivo da solicitação.	6708D849-F109-1A6C-AC91-************
JobType	string	O tipo de tarefa.	transcode
TranscodeJobDetail	object	Os detalhes da tarefa de transcodificação. Este campo tem um valor apenas quando JobType é Transcode.
JobId	string	O ID do job.	2dc1634e**********3f1d22d1a0174e
UserId	integer	O ID do usuário que iniciou a tarefa.	139109*****84930
VideoId	string	O ID do recurso de mídia.	30e5d7**********bd900764de7c0102
Status	string	O status da tarefa. Valores válidos: Submitted: Enviado. Transcoding: Transcodificando. TranscodeSuccess: Transcodificação bem-sucedida. TranscodeFail: Falha na transcodificação. TranscodeCancelled: Transcodificação cancelada.	TranscodeSuccess
TemplateId	string	O ID do modelo.	dbfaaec9e**********bf0b81219244c
Definition	string	A definição.	HD
CreateTime	string	A hora em que a tarefa foi criada. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2024-10-14T07:39:25Z
CompleteTime	string	A hora em que a tarefa foi concluída. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2024-10-14T07:39:34Z
SnapshotJobDetail	object	Os detalhes da tarefa de snapshot. Este campo tem um valor apenas quando JobType é Snapshot.
JobId	string	O ID do job.	63df12s0**********4hdq249t82kr91
UserId	integer	O ID do usuário que iniciou a tarefa.	139109*****84930
VideoId	string	O ID do recurso de mídia.	30e5d7**********bd900764de7c0102
Status	string	O status da tarefa. Valores válidos: Processing: Processando. Fail: Falhou. Success: Bem-sucedido.	Success
Trigger	string	O método de acionamento. Valores válidos: Auto: Acionado automaticamente por um workflow. Manual: Enviado manualmente.	Auto
NormalConfig	string	A configuração de snapshot normal.	{"inl":0,"num":32,"tm":5,"wd":"352","ft":"normal","hg":"640"}
SpriteConfig	string	A configuração de sprite.	{"pad":"0","lines":"10","mgin":"0","cols":"10","ikcp":"false","hg":"68"}
CreateTime	string	A hora em que a tarefa foi criada. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2024-10-14T07:39:25Z
CompleteTime	string	A hora em que a tarefa foi concluída. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2024-10-14T07:39:45Z
AIJobDetail	object	Os detalhes da tarefa de IA. Este campo tem um valor apenas quando TaskType é AI.
JobId	string	O ID do job.	5c9dff751ba**********59d50a967f5
UserId	integer	O ID do usuário que iniciou a tarefa.	139109*****84930
MediaId	string	O ID do recurso de mídia.	30e5d7**********bd900764de7c0102
JobType	string	O tipo de tarefa de IA.	AIVideoCensor
Status	string	O status da tarefa. Valores válidos: reserved: Enviado. init: Iniciado. success: Bem-sucedido. fail: Falhou. processing: Processando. analysing: Analisando.	success
Trigger	string	O método de acionamento. Valores válidos: Auto: Acionado automaticamente por um workflow. Manual: Enviado manualmente.	Auto
TemplateConfig	string	A configuração do modelo.	{"AuditRange":["video","image-cover","text-title"],"AuditContent":["screen"],"AuditItem":["terrorism","porn"],"AuditAutoBlock":"no"}
CreateTime	string	A hora em que a tarefa foi criada. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2024-10-14T07:39:25Z
CompleteTime	string	A hora em que a tarefa terminou. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2024-10-14T07:39:46Z
WorkflowTaskDetail	object	Os detalhes da tarefa de workflow. Este campo tem um valor apenas quando TaskType é Workflow.
TaskId	string	O ID do job.	46ecc024******92c8e26237e51
Status	string	O status da tarefa. Valores válidos: Init: Iniciado. Processing: Processando. Succeed: Bem-sucedido. Failed: Falhou. Canceled: Cancelado. Skip: Ignorado.	Succeed
TaskInput	string	As informações do recurso de mídia.	{\"Type\":\"Media\",\"Media\":\"00f985a50ae371f0ad1c4106e0ea0102\",\"Title\":\"2.mp4\",\"StorageLocation\":\"yiming-pre.oss-cn-shanghai.aliyuncs.com\"}
CreateTime	string	A hora em que a tarefa foi criada. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2025-03-27T08:15:46Z
FinishTime	string	A hora em que a tarefa foi concluída. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2025-03-27T08:20:19Z
ActivityResults	string	Os resultados do processamento de cada nó no workflow, no formato JSON.	{\"VodSnapshot_123\":{\"ActivityId\":\"VodSnapshot\",\"ActivityInstanceId\":\"c8cf62d53bef4e04bf703976bae6d0b9\",\"EndTime\":\"2025-03-27T08:15:51Z\",\"Result\":\"{\\\"RequestId\\\":\\\"8B3649AF-5A6B-1099-BEB6-164D81067398\\\",\\\"EventType\\\":\\\"SnapshotComplete\\\",\\\"UserId\\\":1797131669910763,\\\"MessageBody\\\":{\\\"Status\\\":\\\"success\\\",\\\"VideoId\\\":\\\"00f985a50ae371f0ad1c4106e0ea0102\\\",\\\"EventType\\\":\\\"SnapshotComplete\\\",\\\"EventTime\\\":\\\"2025-03-27T08:15:50Z\\\",\\\"TriggerSource\\\":\\\"{\\\\\\\"ActivityInstanceId\\\\\\\":\\\\\\\"c8cf62d53bef4e04bf703976bae6d0b9\\\\\\\",\\\\\\\"BizType\\\\\\\":\\\\\\\"ice-workflow\\\\\\\"}\\\"}}\",\"StartTime\":\"2025-03-27T08:15:47Z\",\"Status\":\"Succeed\"},\"Translate_zh_en\":{\"ActivityId\":\"VodTranslation\",\"ActivityInstanceId\":\"c043a872bb044763a3d293a5c2458b50\",\"EndTime\":\"2025-03-27T08:20:19Z\",\"Result\":\"{\\\"Type\\\":\\\"VideoTranslationAll\\\",\\\"Success\\\":false}\",\"StartTime\":\"2025-03-27T08:15:46Z\",\"Status\":\"Failed\"},\"Act_Start\":{\"ActivityId\":\"start\",\"ActivityInstanceId\":\"8a9402f4ff064084bf496707fb2d664a\",\"Result\":\"{\\\"Type\\\":\\\"Media\\\",\\\"bizType\\\":6,\\\"Media\\\":\\\"00f985a50ae371f0ad1c4106e0ea0102\\\",\\\"Title\\\":\\\"2.mp4\\\",\\\"taskInput\\\":\\\"{\\\\\\\"Type\\\\\\\":\\\\\\\"Media\\\\\\\",\\\\\\\"Media\\\\\\\":\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\"}\\\",\\\"userTaskInput\\\":\\\"{\\\\\\\"Type\\\\\\\":\\\\\\\"Media\\\\\\\",\\\\\\\"Media\\\\\\\":\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\",\\\\\\\"Title\\\\\\\":\\\\\\\"2.mp4\\\\\\\",\\\\\\\"StorageLocation\\\\\\\":\\\\\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\\\\\"}\\\",\\\"StorageLocation\\\":\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\",\\\"callerUid\\\":1797131669910763,\\\"CUR_NODE_NAME\\\":\\\"Act_Start\\\"}\",\"StartTime\":\"2025-03-27T08:15:45Z\",\"Status\":\"Succeed\"},\"VodDynamicImage_123\":{\"ActivityId\":\"VodDynamicImage\",\"ActivityInstanceId\":\"26e8dab82ab84110b1150f146caf633c\",\"EndTime\":\"2025-03-27T08:15:55Z\",\"Result\":\"{\\\"RequestId\\\":\\\"7120B5D5-430F-14AD-8922-577F072DDD64\\\",\\\"EventType\\\":\\\"DynamicImageComplete\\\",\\\"UserId\\\":1797131669910763,\\\"MessageBody\\\":{\\\"Status\\\":\\\"success\\\",\\\"VideoId\\\":\\\"00f985a50ae371f0ad1c4106e0ea0102\\\",\\\"EventType\\\":\\\"DynamicImageComplete\\\",\\\"EventTime\\\":\\\"2025-03-27T08:15:52Z\\\",\\\"TriggerSource\\\":\\\"{\\\\\\\"ActivityInstanceId\\\\\\\":\\\\\\\"26e8dab82ab84110b1150f146caf633c\\\\\\\",\\\\\\\"BizType\\\\\\\":\\\\\\\"ice-workflow\\\\\\\"}\\\"}}\",\"StartTime\":\"2025-03-27T08:15:47Z\",\"Status\":\"Succeed\"}}
UserData	string	As configurações personalizadas. O valor é uma string JSON que suporta configurações como callbacks de mensagens e aceleração de upload.	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
Workflow	object	Os detalhes do workflow.
WorkflowId	string	O ID do workflow.	vw_09d6*****b5c5b19a0c891e02
Name	string	O nome do workflow.	All_Activity_New_1_app-1000000
Status	string	O status do workflow. Valores válidos: Active: Ativado. Inactive: Não ativado. Deleted: Excluído.	Active
Type	string	O tipo de workflow. Por padrão, este campo não é preenchido.
CreateTime	string	A hora em que o workflow foi criado. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2025-03-26T05:50:14Z
ModifiedTime	string	A hora em que o workflow foi modificado. A hora é exibida em UTC no formato AAAA-MM-DDTHH:MM:SSZ.	2025-03-26T07:51:55Z
AppId	string	O ID do aplicativo.	app-1000000

Exemplos

Resposta de sucesso

JSON formato

{
  "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"
  },
  "WorkflowTaskDetail": {
    "TaskId": "46ecc024******92c8e26237e51",
    "Status": "Succeed",
    "TaskInput": "{\\\"Type\\\":\\\"Media\\\",\\\"Media\\\":\\\"00f985a50ae371f0ad1c4106e0ea0102\\\",\\\"Title\\\":\\\"2.mp4\\\",\\\"StorageLocation\\\":\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\"}",
    "CreateTime": "2025-03-27T08:15:46Z",
    "FinishTime": "2025-03-27T08:20:19Z",
    "ActivityResults": "{\\\"VodSnapshot_123\\\":{\\\"ActivityId\\\":\\\"VodSnapshot\\\",\\\"ActivityInstanceId\\\":\\\"c8cf62d53bef4e04bf703976bae6d0b9\\\",\\\"EndTime\\\":\\\"2025-03-27T08:15:51Z\\\",\\\"Result\\\":\\\"{\\\\\\\"RequestId\\\\\\\":\\\\\\\"8B3649AF-5A6B-1099-BEB6-164D81067398\\\\\\\",\\\\\\\"EventType\\\\\\\":\\\\\\\"SnapshotComplete\\\\\\\",\\\\\\\"UserId\\\\\\\":1797131669910763,\\\\\\\"MessageBody\\\\\\\":{\\\\\\\"Status\\\\\\\":\\\\\\\"success\\\\\\\",\\\\\\\"VideoId\\\\\\\":\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\",\\\\\\\"EventType\\\\\\\":\\\\\\\"SnapshotComplete\\\\\\\",\\\\\\\"EventTime\\\\\\\":\\\\\\\"2025-03-27T08:15:50Z\\\\\\\",\\\\\\\"TriggerSource\\\\\\\":\\\\\\\"{\\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"c8cf62d53bef4e04bf703976bae6d0b9\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"BizType\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"ice-workflow\\\\\\\\\\\\\\\"}\\\\\\\"}}\\\",\\\"StartTime\\\":\\\"2025-03-27T08:15:47Z\\\",\\\"Status\\\":\\\"Succeed\\\"},\\\"Translate_zh_en\\\":{\\\"ActivityId\\\":\\\"VodTranslation\\\",\\\"ActivityInstanceId\\\":\\\"c043a872bb044763a3d293a5c2458b50\\\",\\\"EndTime\\\":\\\"2025-03-27T08:20:19Z\\\",\\\"Result\\\":\\\"{\\\\\\\"Type\\\\\\\":\\\\\\\"VideoTranslationAll\\\\\\\",\\\\\\\"Success\\\\\\\":false}\\\",\\\"StartTime\\\":\\\"2025-03-27T08:15:46Z\\\",\\\"Status\\\":\\\"Failed\\\"},\\\"Act_Start\\\":{\\\"ActivityId\\\":\\\"start\\\",\\\"ActivityInstanceId\\\":\\\"8a9402f4ff064084bf496707fb2d664a\\\",\\\"Result\\\":\\\"{\\\\\\\"Type\\\\\\\":\\\\\\\"Media\\\\\\\",\\\\\\\"bizType\\\\\\\":6,\\\\\\\"Media\\\\\\\":\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\",\\\\\\\"Title\\\\\\\":\\\\\\\"2.mp4\\\\\\\",\\\\\\\"taskInput\\\\\\\":\\\\\\\"{\\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\\"}\\\\\\\",\\\\\\\"userTaskInput\\\\\\\":\\\\\\\"{\\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"Title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"2.mp4\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"StorageLocation\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\\\\\\\\\\\\\"}\\\\\\\",\\\\\\\"StorageLocation\\\\\\\":\\\\\\\"yiming-pre.oss-cn-shanghai.aliyuncs.com\\\\\\\",\\\\\\\"callerUid\\\\\\\":1797131669910763,\\\\\\\"CUR_NODE_NAME\\\\\\\":\\\\\\\"Act_Start\\\\\\\"}\\\",\\\"StartTime\\\":\\\"2025-03-27T08:15:45Z\\\",\\\"Status\\\":\\\"Succeed\\\"},\\\"VodDynamicImage_123\\\":{\\\"ActivityId\\\":\\\"VodDynamicImage\\\",\\\"ActivityInstanceId\\\":\\\"26e8dab82ab84110b1150f146caf633c\\\",\\\"EndTime\\\":\\\"2025-03-27T08:15:55Z\\\",\\\"Result\\\":\\\"{\\\\\\\"RequestId\\\\\\\":\\\\\\\"7120B5D5-430F-14AD-8922-577F072DDD64\\\\\\\",\\\\\\\"EventType\\\\\\\":\\\\\\\"DynamicImageComplete\\\\\\\",\\\\\\\"UserId\\\\\\\":1797131669910763,\\\\\\\"MessageBody\\\\\\\":{\\\\\\\"Status\\\\\\\":\\\\\\\"success\\\\\\\",\\\\\\\"VideoId\\\\\\\":\\\\\\\"00f985a50ae371f0ad1c4106e0ea0102\\\\\\\",\\\\\\\"EventType\\\\\\\":\\\\\\\"DynamicImageComplete\\\\\\\",\\\\\\\"EventTime\\\\\\\":\\\\\\\"2025-03-27T08:15:52Z\\\\\\\",\\\\\\\"TriggerSource\\\\\\\":\\\\\\\"{\\\\\\\\\\\\\\\"ActivityInstanceId\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"26e8dab82ab84110b1150f146caf633c\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"BizType\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"ice-workflow\\\\\\\\\\\\\\\"}\\\\\\\"}}\\\",\\\"StartTime\\\":\\\"2025-03-27T08:15:47Z\\\",\\\"Status\\\":\\\"Succeed\\\"}}",
    "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"},\"Extend\":{\"localId\":\"*****\",\"test\":\"www\"}}",
    "Workflow": {
      "WorkflowId": "vw_09d6*****b5c5b19a0c891e02",
      "Name": "All_Activity_New_1_app-1000000",
      "Status": "Active",
      "Type": "",
      "CreateTime": "2025-03-26T05:50:14Z",
      "ModifiedTime": "2025-03-26T07:51:55Z",
      "AppId": "app-1000000"
    }
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.