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

Descrição da operação

Para arquivos de áudio e vídeo já armazenados em um bucket do OSS conectado ao ApsaraVideo VOD, você deve chamar esta operação para gerar os dados associados exigidos pelo VOD antes de poder iniciar transcodificação, captura de snapshots, processamento de IA e outras operações nesses arquivos por ID de mídia.
Você pode registrar até 10 arquivos de mídia do OSS por vez, e todos os arquivos de mídia enviados em uma única solicitação devem corresponder ao mesmo endereço de armazenamento.
Para arquivos de mídia carregados por meio do VOD, se nenhum ID de grupo de modelos de transcodificação for especificado, o grupo de modelos padrão será usado para transcodificação. Em contraste, após o registro do ativo de mídia, a transcodificação não é acionada automaticamente se nenhum ID de grupo de modelos de transcodificação for especificado. Se um ID de grupo de modelos de transcodificação for especificado, a transcodificação será realizada com base no grupo de modelos especificado.
Se um arquivo de mídia for registrado repetidamente, apenas o ID de mídia exclusivo associado a ele será retornado, e nenhum outro processamento será realizado.
Certifique-se de que o arquivo de mídia que você deseja registrar tenha uma extensão de nome de arquivo válida. Caso contrário, o registro falhará.

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

create

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegisterMetadatas	string	Sim	Os metadados dos ativos de mídia a serem registrados. O valor é uma string JSON. Você pode especificar metadados para até 10 ativos de mídia por vez. Para obter mais informações sobre a estrutura do parâmetro, consulte a tabela RegisterMetadata abaixo.	[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"NomeDoVideo"}]
TemplateGroupId	string	Não	O ID do grupo de modelos de transcodificação. Você pode obter o ID usando um dos seguintes métodos: Faça login no console do ApsaraVideo VOD e escolha Gerenciamento de Configuração > Processamento de Mídia > Grupos de Modelos de Transcodificação para visualizar o ID do grupo de modelos de transcodificação. Obtenha o valor de TranscodeTemplateGroupId na resposta ao chamar a operação CreateTranscodeTemplateGroup. Obtenha o valor de TranscodeTemplateGroupId na resposta ao chamar a operação ListTranscodeTemplateGroup. Nota Se a transcodificação não for necessária, defina este parâmetro como VOD_NO_TRANSCODE (o grupo de modelos sem transcodificação). Caso contrário, o status do vídeo será UploadSucc e o vídeo não poderá ser reproduzido usando o serviço de reprodução. Se a transcodificação for necessária, especifique o ID do grupo de modelos de transcodificação correspondente. Se WorkflowId e TemplateGroupId forem especificados, WorkflowId terá precedência. Para obter mais informações, consulte Workflows. Este parâmetro aciona uma tarefa assíncrona. Após o envio, a tarefa entra em uma fila em segundo plano para execução assíncrona.	ca3a8f6e49c87b65806709586****
UserData	string	Não	As configurações personalizadas. O valor é uma string JSON que suporta configurações como callbacks de mensagens. Para obter mais informações, consulte UserData. Nota Esta operação não suporta callbacks. Mesmo que você configure um callback de mensagem neste parâmetro, nenhuma mensagem de callback será gerada após a conclusão do registro do ativo de mídia. Quando você posteriormente iniciar o processamento de mídia, como transcodificação ou captura de snapshots, no ativo de mídia registrado, se você especificar um callback de mensagem em UserData naquele momento, essa URL de callback terá precedência. Caso contrário, a URL de callback especificada em UserData durante o registro do ativo de mídia será usada.	{"Extend":{"localId":"****","test":"www"}}
WorkflowId	string	Não	O ID do workflow. Faça login no console do ApsaraVideo VOD e escolha Gerenciamento de Configuração > Processamento de Mídia > Gerenciamento de Workflows para visualizar o ID do workflow. Nota Se WorkflowId e TemplateGroupId forem especificados, WorkflowId terá precedência. Para obter mais informações, consulte Workflows. Este parâmetro aciona uma tarefa assíncrona. Após o envio, a tarefa entra em uma fila em segundo plano para execução assíncrona.	637adc2b7ba51a83d841606f8****
EnableFirstFrameCover	boolean	Não
GenerateThumbnail	boolean	Não

RegisterMetadata

Especifica os metadados dos ativos de mídia a serem registrados.

Nome	Tipo	Obrigatório	Descrição
FileURL	String	Sim	A URL do arquivo de origem. Você pode obter este valor chamando a operação GetMezzanineInfo. A URL não pode exceder 1024 bytes. O nome do arquivo deve ser globalmente exclusivo. Se você adicionar um arquivo com o mesmo nome, ele será associado ao ID de mídia exclusivo. A URL está no formato do endpoint público do bucket do OSS + ObjectName (nome do arquivo).
Title	String	Sim	O título. O título não pode exceder 128 bytes. Codificado em UTF-8.
Description	String	Não	A descrição. A descrição não pode exceder 1024 bytes. Codificada em UTF-8.
Tags	String	Não	As tags. Cada tag não pode exceder 32 bytes. Você pode especificar até 16 tags. Separe várias tags com vírgulas (,). Codificadas em UTF-8.
CoverURL	String	Não	A URL da capa. A URL não pode exceder 1024 bytes.
CateId	Long	Não	O ID da categoria. Você pode obter o ID usando um dos seguintes métodos: Faça login no console do ApsaraVideo VOD e escolha Gerenciamento de Configuração > Gerenciamento de Ativos de Mídia > Gerenciamento de Categorias para visualizar o ID da categoria. Obtenha o valor de CateId na resposta ao chamar a operação AddCategory. Obtenha o valor de CateId na resposta ao chamar a operação GetCategories.
ReferenceId	String	Não	O ID personalizado. Apenas letras minúsculas, letras maiúsculas, dígitos, hifens (-) e sublinhados (_) são suportados. O valor deve ter de 6 a 64 caracteres e deve ser exclusivo para cada usuário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	14F43C5C-8033-448B-AD04F64E5098****
FailedFileURLs	array	A lista de URLs de arquivos que falharam ao serem registradas.
	string	A lista de URLs de arquivos que falharam ao serem registradas.	["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]
RegisteredMediaList	array<object>	A lista de ativos de mídia registrados com sucesso, incluindo tanto arquivos recém-registrados quanto arquivos registrados anteriormente.
	object	Os detalhes do registro.
NewRegister	boolean	Indica se o ativo de mídia foi recém-registrado ou registrado repetidamente. true: recém-registrado. false: registrado repetidamente.	false.
FileURL	string	A URL do arquivo no OSS.	http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4
MediaId	string	O ID de mídia do VOD. Se o arquivo de mídia registrado for um arquivo de áudio ou vídeo, este valor corresponde ao VideoId no ApsaraVideo VOD.	d97af32828084d1896683b1aa38****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "14F43C5C-8033-448B-AD04F64E5098****",
  "FailedFileURLs": [
    "[\"http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4\"]"
  ],
  "RegisteredMediaList": [
    {
      "NewRegister": false,
      "FileURL": "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
      "MediaId": "d97af32828084d1896683b1aa38****"
    }
  ]
}

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.