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

Envia um trabalho de snapshot de vídeo para iniciar o processamento assíncrono de snapshots.

Descrição da operação

Esta é uma operação assíncrona. Após enviar uma tarefa, o ID da tarefa é retornado (a tarefa ainda não foi concluída e entra em uma fila para execução assíncrona). O resultado final é enviado por meio de uma notificação de callback. Você também pode consultar proativamente o status da tarefa chamando Obter detalhes da tarefa.
Apenas imagens JPG são suportadas.
Quando o snapshot for concluído, uma notificação de evento de Snapshot de vídeo concluído com EventType=SnapshotComplete e SubType=SpecifiedTime será enviada.

Limite de QPS

O limite de QPS para um único usuário nesta operação é de 30 chamadas por segundo. Se esse limite for excedido, a chamada de API será limitada, o que pode afetar seus negócios. Chame esta operação adequadamente. Para mais informações, consulte Limite 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:SubmitSnapshotJob

create

*全部资源

*

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 usando um dos seguintes métodos: Para vídeos enviados pelo console, faça login no console do ApsaraVideo VOD e escolha Arquivos de mídia > Áudio/Vídeo para visualizar o ID do vídeo. Obtenha o ID do vídeo a partir do valor do parâmetro de resposta VideoId ao chamar a operação CreateUploadVideo para obter a URL e a credencial de upload. Após o upload do vídeo, chame a operação SearchMedia para consultar o ID do vídeo, que corresponde ao valor do parâmetro de resposta VideoId.	d3e680e618708efbf2cae7cc9312****
SpecifiedOffsetTime	integer	Não	O horário inicial para o snapshot. Unidade: milissegundos. Valor padrão: 0.	0
Width	string	Não	A largura do snapshot. Valores válidos: `[8,4096]`. Valor padrão: a largura do vídeo original. Unidade: px.	1280
Height	string	Não	A altura do snapshot. Valores válidos: `[8,4096]`. Valor padrão: a altura do vídeo original. Unidade: px.	720
Count	integer	Não	O número máximo de snapshots. Valor padrão: 1.	1
Interval	integer	Não	O intervalo entre snapshots. O valor deve ser maior ou igual a 0. Unidade: segundos. Valor padrão: 1. Se Interval estiver definido como 0, os snapshots serão capturados uniformemente com base no valor de Count e na duração do vídeo.	1
SpriteSnapshotConfig	string	Não	A configuração de sprite. Se este parâmetro não estiver vazio, um sprite será gerado. Para mais informações sobre a estrutura do parâmetro, consulte SpriteSnapshotConfig.	{'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}
SnapshotTemplateId	string	Não	O ID do modelo de snapshot. Recomendamos que você crie um modelo de snapshot primeiro e depois passe o ID do modelo de snapshot. Para mais informações sobre como criar um modelo de snapshot, consulte Adicionar um modelo de snapshot. Se você passar o ID do modelo de snapshot, todos os parâmetros da solicitação, exceto Action e VideoId, serão ignorados.	f5b228fe693bf55bd87b789****
UserData	string	Não	As configurações personalizadas. Apenas strings JSON são suportadas. Você pode usar este parâmetro para transmitir dados personalizados e especificar configurações de URL de callback. Para mais informações sobre a estrutura do parâmetro, consulte UserData. Nota Para usar o callback de mensagem neste parâmetro, configure a URL de callback HTTP e selecione os tipos de evento de callback correspondentes no console. Caso contrário, as configurações de callback não entrarão em vigor.	{"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
SpecifiedOffsetTimes	array	Não	Os pontos no tempo em que os snapshots são capturados. Unidade: milissegundos. Você pode especificar até 30 pontos no tempo por vez.
	integer	Não	O ponto no tempo personalizado. Unidade: milissegundos.	1000
ReferenceId	string	Não	O ID personalizado. Apenas letras minúsculas, letras maiúsculas, dígitos, hifens e sublinhados são suportados. Comprimento: 6 a 64 caracteres. O valor deve ser único no nível de usuário.	123-123

Nota

Você deve especificar pelo menos um dos parâmetros Count ou Interval. Se ambos forem especificados, prevalecerá o menor número de snapshots.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	25818875-5F78-5EB0-4AF6-D7393642****
SnapshotJob	object	As informações do trabalho de snapshot.
JobId	string	O ID do trabalho de snapshot.	ad90a501b1b94b72374ad0050464****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "25818875-5F78-5EB0-4AF6-D7393642****",
  "SnapshotJob": {
    "JobId": "ad90a501b1b94b72374ad0050464****"
  }
}

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.