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

Nota

Somente snapshots no formato JPG são gerados.
Após a conclusão do job de snapshot, o ApsaraVideo VOD envia uma notificação de evento SnapshotComplete com EventType=SnapshotComplete e SubType=SpecifiedTime.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	SubmitSnapshotJob	A operação a ser executada. Defina o valor como SubmitSnapshotJob.
VideoId	String	Sim	d3e680e618708*****efbf2cae7cc931	O ID do vídeo.
SpecifiedOffsetTime	Long	Não	0	O horário inicial do período especificado para o snapshot. Unidade: milissegundos. Valor padrão: 0.
Width	String	Não	1280	A largura de cada snapshot. Valores válidos: `[8,4096]`. Por padrão, o sistema usa a largura do arquivo mezzanine do vídeo. Unidade: pixel.
Height	String	Não	720	A altura de cada snapshot. Valores válidos: `[8,4096]`. Por padrão, o sistema usa a altura do arquivo mezzanine do vídeo. Unidade: pixel.
Count	Long	Não	1	O número máximo de snapshots. Valor padrão: 1.
Interval	Long	Não	1	O intervalo entre snapshots. O valor deve ser maior ou igual a 0. Unidade: segundos. Se você definir este parâmetro como 0, os snapshots serão capturados em intervalos uniformes com base na duração do vídeo dividida pelo valor do parâmetro Count. Valor padrão: 1.
SpriteSnapshotConfig	String	Não	{'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}	A configuração de snapshot sprite. Se definido, gera snapshots sprite. Para obter mais informações, consulte SpriteSnapshotConfig.
SnapshotTemplateId	String	Não	f5b228fe693*****bf55bd87789	O ID do modelo de snapshot. Recomendamos criar um modelo de snapshot antes de especificar o ID do modelo. Se você definir o parâmetro SnapshotTemplateId, todos os outros parâmetros de solicitação, exceto Action e VideoId, serão ignorados. Para obter mais informações sobre como criar um modelo de snapshot, consulte AddVodTemplate.
UserData	String	Não	{"MessageCallback":{"CallbackURL":"http://test.test.com"},"Extend":{"localId":"xxx","test":"www"}}	As configurações personalizadas, incluindo transmissão transparente de dados e callback. O valor é uma string formatada em JSON. Para obter mais informações, consulte UserData. Nota As configurações de callback entram em vigor apenas quando você especifica a URL de callback HTTP e seleciona os eventos de callback específicos no console do ApsaraVideo VOD.

Nota

Defina pelo menos um dos parâmetros Count ou Interval. Se ambos forem definidos, prevalece a configuração que gerar menos snapshots.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	25818875-5F78-4A*F6-D7393642CA58	O ID da solicitação.
SnapshotJob	Struct		As informações sobre o job de snapshot.
JobId	String	ad90a501b1b94b*72374ad005046	O ID do job de snapshot.

Exemplos

Exemplos de solicitações

https://vod.{ApiRegion}.aliyuncs.com/?Action=SubmitSnapshotJob
&VideoId=d3e680e618708*****efbf2cae7cc931
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<SubmitSnapshotJobResponse>
      <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
      <SnapshotJob>
            <JobId>ad90a501b1b94b*****72374ad005046</JobId>
      </SnapshotJob>
</SubmitSnapshotJobResponse>

Formato JSON

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "SnapshotJob": {
        "JobId": "ad90a501b1b94b*****72374ad005046"
    }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.

Erros comuns

A tabela a seguir descreve os erros comuns retornados por esta operação.

Código de erro	Mensagem de erro	Código de status HTTP	Descrição
InvalidVideo.NotFound	The video does not exist.	404	Mensagem de erro retornada porque o vídeo não existe.
NoSuchResource	The specified resource %s does not exist.	404	Mensagem de erro retornada porque o recurso especificado não existe.
Forbidden.IllegalStatus	Status of the video is illegal.	400	Mensagem de erro retornada porque o status do vídeo é inválido. Só é possível enviar um job de snapshot para um vídeo quando ele estiver no estado UploadSucc, Normal, Checking ou Blocked.

Exemplos de SDK

Recomendamos usar um SDK de servidor para chamar esta operação. Para obter mais informações sobre o código de exemplo usado para chamar esta operação em várias linguagens, consulte os seguintes tópicos: