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

Observações de uso

Após armazenar um arquivo de áudio ou vídeo em um bucket do Object Storage Service (OSS) utilizado pelo ApsaraVideo VOD, chame a operação RegisterMedia para registrar o arquivo de mídia. Depois que o arquivo for registrado, utilize o ID de mídia associado para enviar tarefas de transcodificação e snapshots no ApsaraVideo VOD. Para mais informações, consulte SubmitTranscodeJobs e SubmitSnapshotJob.

Nota

Registre até 10 arquivos de mídia do OSS com o mesmo local de armazenamento por vez.
Ao fazer upload de um arquivo de mídia pelo console do ApsaraVideo VOD sem especificar um ID de grupo de modelos de transcodificação, o sistema utiliza o grupo de modelos padrão para transcodificar o arquivo. No entanto, se você chamar a operação RegisterMedia sem definir esse ID, o ApsaraVideo VOD não iniciará a transcodificação automaticamente após o registro. Caso especifique um ID de grupo de modelos de transcodificação, o serviço usará o grupo indicado para processar o arquivo.
Se o arquivo de mídia desejado já tiver sido registrado anteriormente, esta operação retornará apenas o ID de mídia exclusivo associado a ele, sem realizar nenhum processamento adicional.

Limite de QPS

Esta operação permite até 50 chamadas por segundo por conta. Se a quantidade de solicitações ultrapassar esse limite, o throttling será acionado, o que pode afetar seus serviços. Recomendamos considerar essa restrição ao utilizar esta operação. Para mais detalhes, consulte Limites de QPS para operações de API no ApsaraVideo VOD.

Depuração

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	RegisterMedia	A operação a ser executada. Defina o valor como RegisterMedia.
RegisterMetadatas	String	Sim	[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]	Os metadados do arquivo de mídia a ser registrado. O valor deve ser uma string JSON. Especifique metadados para no máximo 10 arquivos de mídia simultaneamente. Para mais informações sobre os metadados dos arquivos de mídia, consulte a seção RegisterMetadata deste tópico.
TemplateGroupId	String	Não	ca3a8f6e49c87b65806709586****	O ID do grupo de modelos de transcodificação. Utilize um dos métodos abaixo para obter esse ID: Faça login no console do ApsaraVideo VOD. No painel de navegação à esquerda, escolha Configuration Management > Media Processing > Transcoding Template Groups. Na página Transcoding Template Groups, visualize o ID do grupo de modelos de transcodificação. Verifique o valor do parâmetro TranscodeTemplateGroupId retornado pela operação AddTranscodeTemplateGroup usada para criar um grupo de modelos de transcodificação. Consulte o valor do parâmetro TranscodeTemplateGroupId retornado pela operação ListTranscodeTemplateGroup utilizada para consultar um grupo de modelos de transcodificação. Nota Caso não seja necessário transcodificar o arquivo de mídia, defina o parâmetro TemplateGroupId como VOD_NO_TRANSCODE. Caso contrário, ocorrerá uma exceção durante a reprodução do vídeo. Se a transcodificação for necessária, especifique o ID do grupo de modelos de transcodificação. Quando os parâmetros WorkflowId e TemplateGroupId forem definidos simultaneamente, o valor de WorkflowId terá prioridade. Para mais informações, consulte Workflows.
UserData	String	Não	null	Configurações personalizadas, como definições de callback. O valor deve ser uma string JSON. Para mais detalhes, consulte a seção "UserData: especifica as configurações personalizadas para upload de mídia" no tópico Parâmetros da solicitação.
WorkflowId	String	Não	637adc2b7ba51a83d841606f8****	O ID do workflow. Para visualizar o ID do workflow, faça login no console do ApsaraVideo VOD. No painel de navegação à esquerda, escolha Configuration Management > Media Processing > Workflows. Nota Se os parâmetros WorkflowId e TemplateGroupId estiverem definidos ao mesmo tempo, o valor de WorkflowId prevalecerá. Para mais informações, consulte Workflows.

RegisterMetadata

A tabela a seguir descreve os metadados do arquivo de mídia a ser registrado.

Parâmetro	Tipo	Obrigatório	Descrição
FileURL	String	Sim	A URL do OSS do arquivo source. Chame a operação GetMezzanineInfo para obter essa URL. A URL pode ter até 1.024 bytes de comprimento. O nome do arquivo deve ser globalmente único. Se o arquivo de mídia que você pretende registrar já existir, o sistema retornará apenas o ID de mídia exclusivo associado a ele.
Title	String	Sim	O título do arquivo de mídia. Pode conter até 128 bytes e deve estar codificado em UTF-8.
Description	String	Não	A descrição do arquivo de mídia. Admite até 1.024 bytes e requer codificação UTF-8.
Tags	String	Não	Uma ou mais tags do arquivo de mídia. Cada tag pode ter até 32 bytes, com limite de 16 tags no total. Separe múltiplas tags por vírgulas (,). O valor precisa estar codificado em UTF-8.
CoverURL	String	Não	A URL da miniatura. Esta URL aceita até 1.024 bytes de tamanho.
CateId	Long	Não	O ID da categoria do arquivo de mídia. Obtenha o ID da categoria por um dos seguintes métodos: Faça login no console do ApsaraVideo VOD. No painel de navegação à esquerda, escolha Configuration Management > Media Management > Categories. Na página Categories, visualize o ID da categoria do arquivo de mídia. Verifique o valor do parâmetro CateId retornado pela operação AddCategory usada para criar uma categoria. Consulte o valor do parâmetro CateId retornado pela operação GetCategories utilizada para pesquisar uma categoria.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	14F43C5C-8033-448B-AD04F64E5098****	O ID da solicitação.
FailedFileURLs	Array of String	["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]	As URLs dos arquivos de mídia que falharam no registro.
RegisteredMediaList	Array of RegisteredMedia		Lista de arquivos de mídia registrados, incluindo tanto novos registros quanto arquivos já registrados anteriormente.
NewRegister	Boolean	false	Indica se o arquivo de mídia foi recém-registrado ou se é um registro repetido. Valores válidos: true: O arquivo de mídia é um novo registro. false: O arquivo de mídia já havia sido registrado anteriormente.
FileURL	String	http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4	A URL do OSS do arquivo de mídia.
MediaId	String	d97af32828084d1896683b1aa38****	O ID do arquivo de mídia registrado no ApsaraVideo VOD. Se o arquivo registrado for de áudio ou vídeo, o valor do parâmetro VideoId retornado pelo ApsaraVideo VOD será aplicado.

Exemplos

Exemplos de solicitações

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=RegisterMedia
&RegisterMetadatas=[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]
&UserData={"Extend":{"localId":"****","test":"www"}}
&WorkflowId=637adc2b7ba51a83d841606f8****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<RegisterMediaResponse>
    <RequestId>14F43C5C-8033-43E7-B48B-AD04F64E5098</RequestId>
    <RegisteredMediaList>
        <MediaId>d97af328280842229aed1896683b1aa38</MediaId>
        <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4</FileURL>
        <NewRegister>true</NewRegister>
    </RegisteredMediaList>
    <RegisteredMediaList>
        <MediaId>d97af328280842229aed1896683b1aa38</MediaId>
        <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4</FileURL>
        <NewRegister>false</NewRegister>
    </RegisteredMediaList>
    <FailedFileURLs>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4</FailedFileURLs>
</RegisterMediaResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "14F43C5C-8033-43E7-B48B-AD04F64E5098",
  "RegisteredMediaList" : [ {
    "MediaId" : "d97af328280842229aed1896683b1aa38",
    "FileURL" : "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
    "NewRegister" : true
  }, {
    "MediaId" : "d97af328280842229aed1896683b1aa38",
    "FileURL" : "http://*****.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4",
    "NewRegister" : false
  } ],
  "FailedFileURLs" : [ "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4" ]
}

Códigos de erro

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