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

Submete trabalhos de transcodificação de mídia e inicia a transcodificação assíncrona.

Descrição da operação

Notas de uso

A transcodificação de mídia é um recurso pago. Antes de chamar esta API, certifique-se de estar familiarizado com os métodos de cobrança e os preços do ApsaraVideo VOD. Para mais informações, consulte Cobrança de transcodificação de mídia.
Esta é uma API assíncrona. O trabalho é colocado na fila em segundo plano para processamento assíncrono. O resultado é enviado por meio de callback. Você também pode consultar o status do trabalho chamando a operação GetTaskDetails.
Você pode iniciar um trabalho de transcodificação apenas para vídeos que estejam nos estados Uploaded, Normal ou Under Review.
Para obter o resultado da transcodificação, você pode receber callbacks de mensagem para os seguintes eventos: Single Transcoding Job Complete e All Transcoding Jobs Complete.
Esta API oferece suporte à substituição dinâmica de URLs de legendas em trabalhos de empacotamento de streaming de taxa de bits adaptativa HLS. Se um trabalho de empacotamento não exigir o processamento de legendas, não use esta API. Em vez disso, especifique o ID do grupo de modelos de empacotamento correspondente ao carregar o vídeo para acionar automaticamente o processo de empacotamento.

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

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VideoId	string	Não	O ID do vídeo. Você pode obter o ID do vídeo de uma das seguintes maneiras: Para vídeos carregados no console do ApsaraVideo VOD, faça login no console do ApsaraVideo VOD e escolha Arquivos de mídia > Áudio/Vídeo para visualizar o ID do vídeo. Ao carregar um vídeo chamando a API CreateUploadVideo, o ID do vídeo é o valor do parâmetro VideoId na resposta. Após o carregamento de um vídeo, você pode chamar a API SearchMedia para consultar o ID do vídeo, que é o valor do parâmetro VideoId na resposta.	142710f878bd42508932f660d7b1****
TemplateGroupId	string	Sim	O ID do grupo de modelos de transcodificação a ser usado para a transcodificação de mídia. Para visualizar o ID do grupo de modelos, faça login no console do ApsaraVideo VOD e escolha Gerenciamento de configuração > Configurações de processamento de mídia > Grupo de modelos de transcodificação.	0e408c803baf658ee637790c5d9f****
PipelineId	string	Não	O ID do pipeline.	d3e680e618708erf45fbf2cae7c****
EncryptConfig	string	Não	A configuração de criptografia, especificada como uma string JSON. Este parâmetro é necessário apenas para a criptografia padrão HLS. Nota O parâmetro CipherText na estrutura EncryptConfig deve ser uma chave de texto cifrado AES_128 gerada ao chamar a API GenerateKMSDataKey. Caso contrário, o trabalho de transcodificação com criptografia padrão HLS falhará. Para mais informações sobre como implementar a criptografia padrão HLS, consulte Criptografia padrão HLS. Tanto para a criptografia padrão HLS quanto para a criptografia privada, você deve selecionar a opção de criptografia HLS no modelo que corresponde ao TemplateGroupId especificado. Caso contrário, o vídeo de saída não será criptografado.	{"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3**", "DecryptKeyUri":"http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3**","KeyServiceType":"KMS"}
OverrideParams	string	Não	Parâmetros de substituição, especificados como uma string JSON. Você pode usar este parâmetro para substituir configurações no modelo de transcodificação, incluindo o arquivo de marca d'água de imagem, o conteúdo da marca d'água de texto, a URL do arquivo de legenda e o formato de codificação do arquivo de legenda. Para obter detalhes sobre a estrutura do parâmetro, consulte OverrideParams.	{"Watermarks":[{"WatermarkId":"af2afe4761992c47dae973374**","FileUrl":"http://developer.aliyundoc.com/image/image.png"},{"WatermarkId":"e8e5b8038d7ada85b376c2707**","Content":"watermark test"}]}
Priority	string	Não	A prioridade do trabalho de transcodificação na fila. Valores válidos: 1 a 10. O valor 10 indica a prioridade mais alta. Valor padrão: 6. Nota Este parâmetro afeta apenas a prioridade do trabalho de transcodificação atual entre todos os trabalhos na fila. Ele não afeta a prioridade dos trabalhos que estão sendo processados.	6
UserData	string	Não	Configurações personalizadas, especificadas como uma string JSON. Você pode definir configurações como callbacks de mensagem. Para mais informações, consulte UserData. Nota Para usar o recurso de callback de mensagem, você deve primeiro configurar uma URL de callback HTTP e selecionar os tipos de evento correspondentes no console. Caso contrário, as configurações de callback não terão efeito.	{"Extend":{"localId":"**","test":"*"}}
SessionId	string	Não	Uma chave de idempotência personalizada. Se você enviar uma solicitação com a mesma chave de idempotência dentro de sete dias, a solicitação falhará e um erro será retornado. A chave pode ter até 50 caracteres e pode conter letras maiúsculas e minúsculas, dígitos, hifens (-) e sublinhados (_). Se você não especificar este parâmetro ou passar uma string vazia, o sistema não deduplicará a solicitação.	5c62d40299034bbaa4c195da330****
ReferenceId	string	Não	Um ID personalizado que deve ser exclusivo para cada usuário. O ID pode ter de 6 a 64 caracteres e pode conter letras minúsculas, letras maiúsculas, dígitos, hifens (-) e sublinhados (_).	123-123

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
TranscodeTaskId	string	O ID da tarefa de transcodificação submetida.	9f4a0df7da2c8a81c8c0408c84****
RequestId	string	O ID da solicitação.	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
TranscodeJobs	object	A lista de trabalhos de transcodificação.
TranscodeJob	array<object>	Detalhes dos trabalhos de transcodificação de mídia. Nota Este parâmetro não é retornado para trabalhos de empacotamento de streaming de taxa de bits adaptativa HLS. Você deve receber callbacks assíncronos para lidar com os resultados.
	object	Detalhes de um trabalho de transcodificação.
JobId	string	The job ID. Nota This parameter is not returned for HLS adaptive bitrate streaming packaging jobs. You must receive asynchronous callbacks to handle the results.	d8921ce8505716cfe86fb112c4****

Exemplos

Resposta de sucesso

JSON formato

{
  "TranscodeTaskId": "9f4a0df7da2c8a81c8c0408c84****",
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "TranscodeJobs": {
    "TranscodeJob": [
      {
        "JobId": "d8921ce8505716cfe86fb112c4****"
      }
    ]
  }
}

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.