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

Cria um modelo de marca d'água de imagem ou texto. Para simplificar o processamento de marcas d'água, o ApsaraVideo VOD encapsula parâmetros complexos de marca d'água, como posição, tamanho, fonte e cor, em modelos, que são referenciados por IDs de modelo de marca d'água exclusivos.

Descrição da operação

Você pode chamar esta operação para adicionar um modelo de marca d'água de imagem (Image) ou texto (Text). Os modelos de marca d'água de imagem suportam os seguintes formatos: imagens estáticas (PNG) e imagens animadas (GIF, APNG e MOV).
Após adicionar um modelo de marca d'água de imagem ou texto, 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. Isso permite que você use o modelo de marca d'água para tarefas subsequentes de transcodificação de marca d'água.
Para obter mais informações sobre como adicionar marcas d'água de imagem ou texto a vídeos, consulte Marcas d'água de imagem e texto.

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

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Type	string	Sim	O tipo de modelo de marca d'água. Valores válidos: Image: modelo de marca d'água de imagem. Este é o valor padrão. Text: modelo de marca d'água de texto.	Image
Name	string	Sim	O nome do modelo de marca d'água. O nome pode conter apenas caracteres chineses e ingleses e dígitos. O nome pode ter até 128 bytes de comprimento. O nome deve ser codificado em UTF-8.	Image watermark template
WatermarkConfig	string	Sim	As informações de configuração da marca d'água de imagem ou texto no formato JSON. A configuração inclui a posição de exibição e os efeitos da marca d'água. Os parâmetros de configuração para marcas d'água de imagem e de texto são diferentes. Para obter 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 OSS do arquivo de imagem da marca d'água. A URL não contém informações de autenticação. Nota O parâmetro de solicitação é obrigatório ao criar um modelo de marca d'água de imagem definindo `Type` como `Image`. Você pode chamar a operação CreateUploadAttachedMedia para carregar uma imagem de marca d'água no ApsaraVideo VOD. O valor do parâmetro `FileURL` retornado após o carregamento pode ser usado como o valor do parâmetro de solicitação.	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 o sistema de múltiplos aplicativos estiver ativado, você pode especificar um ID de aplicativo para adicionar o modelo de marca d'água a um aplicativo específico. Para obter mais informações, consulte Sistema de múltiplos aplicativos.	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 do modelo de marca d'água.
CreationTime	string	A hora em que o modelo de marca d'água foi criado. A hora segue o formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2018-11-07T09:05:52Z
Type	string	O tipo do modelo de marca d'água. Valores válidos: 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 modelo padrão de marca d'água de imagem ou texto. Valores válidos: Default: modelo padrão de marca d'água de imagem ou texto NotDefault: modelo não padrão de marca d'água de imagem ou texto	NotDefault
FileUrl	string	A URL do arquivo da marca d'água. A URL pode ser uma URL do OSS ou uma URL da 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 de imagem ou texto no formato JSON. A configuração inclui a posição de exibição e os efeitos da marca d'água. Os parâmetros de configuração para marcas d'água de imagem e de texto são diferentes. Para obter 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. Você pode usar o ID do modelo de marca d'água para associar o modelo de marca d'água a um grupo de modelos de transcodificação, ou para consultar, modificar ou excluir o modelo de marca d'água, ou defini-lo como o modelo de marca d'água padrão.	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.