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

Cria um modelo de marca d'água de imagem ou texto. O ApsaraVideo VOD permite criar modelos de marca d'água para reutilizar suas configurações de parâmetros, como posição, tamanho, fonte e cor da marca d'água. Cada modelo de marca d'água recebe um ID exclusivo. Isso simplifica o processamento de tarefas de marca d'água.

Descrição da operação

Você pode chamar esta operação para criar um modelo de marca d'água Image ou um modelo de marca d'água Text. Você pode usar imagens estáticas no formato PNG ou imagens dinâmicas nos formatos GIF, APNG e MOV como marcas d'água de imagem.
Após chamar esta operação para criar um modelo de marca d'água, você deve chamar a operação AddTranscodeTemplateGroup ou UpdateTranscodeTemplateGroup para associar o modelo de marca d'água a um grupo de modelos de transcodificação. Dessa forma, você pode adicionar marcas d'água aos vídeos durante a transcodificação.
Para mais informações, consulte Marcas d'água de vídeo.

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

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Type	string	Sim	O tipo do modelo de marca d'água. Valores válidos: Image (padrão): modelo de marca d'água de imagem Text: modelo de marca d'água de texto	Image
Name	string	Sim	O nome do modelo de marca d'água. Apenas letras e dígitos são aceitos. O nome não pode exceder 128 bytes. O valor deve ser codificado em UTF-8.	Image watermark template
WatermarkConfig	string	Sim	As informações de configuração da marca d'água, como a posição de exibição e efeitos especiais. O valor deve ser uma string JSON. Os parâmetros de configuração para marcas d'água de imagem e texto são diferentes. Para mais informações sobre a estrutura de parâmetros, consulte WatermarkConfig.	{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }
FileUrl	string	Não	A URL do arquivo de marca d'água. A URL deve ser uma URL do Object Storage Service (OSS) e não pode conter as informações usadas para assinatura de URL. Nota Este parâmetro é obrigatório se você definir `Type` como `Image`. Você pode obter a URL a partir do parâmetro `FileURL` na resposta da operação CreateUploadAttachedMedia que você chama para fazer upload da imagem de marca d'água para o ApsaraVideo VOD.	http://outin-326268***63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345***E7FDEC-6-2.png
AppId	string	Não	O ID do aplicativo. Valor padrão: app-1000000. Se você ativou o serviço de múltiplos aplicativos, especifique o ID do aplicativo para adicionar o modelo de marca d'água ao aplicativo especificado. Para mais informações, consulte Visão geral.	app-****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	As informações sobre o modelo de marca d'água.
CreationTime	string	A hora em que o modelo de marca d'água foi criado. A hora segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2018-11-07T09:05:52Z
Type	string	O tipo do modelo de marca d'água. Image: modelo de marca d'água de imagem Text: modelo de marca d'água de texto	Image
IsDefault	string	Indica se o modelo de marca d'água é o padrão. Valores válidos: Default NotDefault	NotDefault
FileUrl	string	A URL do arquivo de marca d'água. A URL é uma URL do Object Storage Service (OSS) ou uma URL do Alibaba Cloud CDN. Nota Este parâmetro é retornado apenas para modelos de marca d'água de imagem.	https://outin-3262***9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**
WatermarkConfig	string	As informações de configuração da marca d'água, como a posição de exibição e efeitos especiais. O valor é uma string JSON. Os parâmetros de configuração para marcas d'água de imagem e texto são diferentes. Para mais informações sobre a estrutura de parâmetros, consulte WatermarkConfig.	{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }
Name	string	O nome do modelo de marca d'água.	Image watermark template
WatermarkId	string	O ID do modelo de marca d'água.	9bcc8bfadb84*****109a2671d0df97

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-07T09:05:52Z",
    "Type": "Image",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\n      \"Width\": \"55\",\n      \"Height\": \"55\",\n      \"Dx\": \"9\",\n      \"Dy\": \"9\",\n      \"ReferPos\": \"BottomLeft\"\n}",
    "Name": "Image watermark template",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

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.