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

Obtém a credencial de reprodução (PlayAuth) para um arquivo de áudio ou vídeo. O ApsaraVideo Player SDK usa essa credencial para obter automaticamente a URL de reprodução. Como a credencial de reprodução possui um período de validade e está vinculada a um arquivo de áudio ou vídeo específico, ela não pode ser compartilhada ou reutilizada. Uma credencial expirada ou inválida causará falha na reprodução. Este método de reprodução é adequado para cenários de reprodução de áudio e vídeo que exigem alta segurança.

Descrição da operação

Ao usar o ApsaraVideo Player SDK (aplicável ao método de reprodução PlayAuth), chame esta operação para obter a credencial de reprodução. O ApsaraVideo Player SDK usa a credencial de reprodução para obter automaticamente a URL de reprodução. Para mais informações, consulte ApsaraVideo Player SDK.
Se a credencial de reprodução expirar, a URL de reprodução não poderá ser obtida. Você deve obter uma nova credencial de reprodução.

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

get

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VideoId	string	Não	O ID do áudio ou vídeo. Apenas um único ID de áudio ou vídeo é suportado. Você pode obter o ID usando os seguintes métodos: Para vídeos enviados por meio do console, faça login no console do ApsaraVideo VOD e escolha Arquivos de mídia > Áudio/Vídeo para visualizar o ID do áudio ou vídeo. Ao enviar arquivos de áudio ou vídeo chamando a operação CreateUploadVideo, o ID do áudio ou vídeo é o valor do parâmetro de resposta VideoId. Após o envio do arquivo de áudio ou vídeo, você pode chamar a operação SearchMedia para consultar o ID do áudio ou vídeo, que é o valor do parâmetro de resposta VideoId.	dfde02284a5c46622a097adaf44a****
AuthInfoTimeout	integer	Não	O tempo de expiração da credencial de reprodução. Unidade: segundos. Se a credencial expirar, a URL de reprodução não poderá ser obtida. Você deve obter uma nova credencial. Valor padrão: 100. Valores válidos: `[100,3000]`.	100
ApiVersion	string	Não	O número da versão da API. Defina o valor como 1.0.0.	1.0.0
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 ID é único por usuário.	123-123

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
PlayAuth	string	A credencial de reprodução para o arquivo de áudio ou vídeo.	sstyYuew6789000000xtt7TYUh****
RequestId	string	O ID da solicitação.	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
VideoMeta	object	Os metadados do arquivo de áudio ou vídeo.
Status	string	O status do arquivo de áudio ou vídeo. Para valores válidos e descrições, consulte Status: status de áudio e vídeo.	Normal.
Duration	number	A duração do arquivo de áudio ou vídeo. Unidade: segundos.	120.0
Title	string	O título do arquivo de áudio ou vídeo.	Título do vídeo VOD do Alibaba Cloud.
VideoId	string	O ID do áudio ou vídeo.	dfde02284a5c46622a097adaf44a****
CoverURL	string	A URL da miniatura do arquivo de áudio ou vídeo.	https://example.aliyundoc.com/****.jpg.

Exemplos

Resposta de sucesso

JSON formato

{
  "PlayAuth": "sstyYuew6789000000xtt7TYUh****",
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "VideoMeta": {
    "Status": "Normal",
    "Duration": 120,
    "Title": "Alibaba Cloud VOD Video Title",
    "VideoId": "dfde02284a5c46622a097adaf44a****",
    "CoverURL": "https://example.aliyundoc.com/****.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.