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

Consulta snapshots gerados por tarefas de snapshot de vídeo e snapshots em miniatura gerados automaticamente pelo sistema durante o upload do vídeo.

Descrição da operação

Se várias tarefas de snapshot tiverem sido iniciadas para um vídeo, esta operação retornará apenas os dados da tarefa de snapshot bem-sucedida mais recente.

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

list

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VideoId	string	Sim	O ID do vídeo. Você pode obter o ID do vídeo usando um dos seguintes métodos: 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 na resposta da operação CreateUploadVideo que você chama para obter a URL e a credencial de upload. Obtenha o ID do vídeo na resposta da operação SearchMedia que você chama para consultar vídeos.	d3e680e618708fbf2cae7cc931****
SnapshotType	string	Não	O tipo de snapshots a serem retornados. Valores válidos: CoverSnapshot (padrão): snapshots em miniatura. NormalSnapshot: snapshots normais. SpriteSnapshot: sprites. SpriteOriginSnapshot: imagens originais dos sprites. WebVttSnapshot: snapshots WebVTT.	CoverSnapshot.
AuthTimeout	string	Não	O tempo de expiração da URL de acesso ao snapshot. Valor padrão: 3600. Valor mínimo: 3600. Unidade: segundos. Este parâmetro entra em vigor somente se a autenticação de URL estiver ativada. Se o valor especificado for inferior a 3600 segundos, o valor padrão de 3600 segundos será usado. Se a URL retornada for uma URL do OSS, o valor máximo é 2592000 (30 dias) para reduzir riscos de segurança ao servidor de origem.	3600
PageSize	string	Não	O número de entradas por página. Valor padrão: 20. Valor máximo: 100.	20
PageNo	string	Não	O número da página. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	25818875-5F78-4AF6-D7393642CA58****
MediaSnapshot	object	Os dados de snapshot do vídeo.
CreationTime	string	A hora em que a tarefa de snapshot foi criada. A hora está no formato aaaa-MM-ddTHH:mm:ssZ (UTC).	2017-12-20T12:23:45Z
Regular	string	A regra para geração de URLs de snapshot.	http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg.
Total	integer	O número total de snapshots.	100
JobId	string	O ID da tarefa de snapshot.	ad90a501b1b9472374ad005046****
Snapshots	object
Snapshot	array<object>	Os detalhes do snapshot.
	object	Os dados do snapshot.
Index	integer	O índice do snapshot.	1
Url	string	A URL do snapshot.	http://example.aliyundoc.com/snapshot/sample00001****.jpg

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "MediaSnapshot": {
    "CreationTime": "2017-12-20T12:23:45Z",
    "Regular": "http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg",
    "Total": 100,
    "JobId": "ad90a501b1b9472374ad005046****",
    "Snapshots": {
      "Snapshot": [
        {
          "Index": 1,
          "Url": "http://example.aliyundoc.com/snapshot/sample00001****.jpg"
        }
      ]
    }
  }
}

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.