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

Nota

O ApsaraVideo VOD suporta marcas d'água de imagem estática, como arquivos PNG, e marcas d'água de imagem dinâmica, como arquivos GIF, APNG e MOV.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	AddWatermark	A operação que você deseja executar. Defina o valor como AddWatermark.
Name	String	Sim	Watermark	O nome da marca d'água. Apenas letras e dígitos são suportados. O nome pode ter até 128 bytes de comprimento. O valor deve ser codificado em UTF-8.
Type	String	Sim	Text	O tipo da marca d'água. Valores válidos: Image: Este é o valor padrão. Text
WatermarkConfig	String	Sim	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}	As configurações, como posição e efeito da marca d'água de texto ou de imagem. O valor é uma string formatada em JSON. Nota O valor deste parâmetro varia conforme o tipo de marca d'água. Para obter mais informações sobre a estrutura de dados, consulte a seção "WatermarkConfig" do tópico Parâmetros de processamento de mídia.
FileUrl	String	Não	http://outin-326268***63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345***E7FDEC-6-2.png	A URL do Object Storage Service (OSS) do arquivo de marca d'água. Você deve definir este parâmetro se adicionar marcas d'água de imagem.
AppId	String	Não	app-****	O ID do aplicativo. Valor padrão: app-1000000. Para obter mais informações, consulte Visão geral.

Nota

Para obter mais informações sobre como fazer upload de um arquivo de marca d'água, consulte

CreateUploadAttachedMedia

.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	25818875-5F78-4A*****F6-D7393642CA58	O ID da solicitação.
WatermarkInfo	Struct		As informações sobre a marca d'água.
CreationTime	String	2018-11-07T09:05:52Z	O momento em que a marca d'água foi adicionada. O horário segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.
FileUrl	String	https://outin-3262***9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**	A URL do OSS ou da Content Delivery Network (CDN) do arquivo de marca d'água. Uma marca d'água de texto não possui URL de arquivo.
IsDefault	String	NotDefault	Indica se a marca d'água é a padrão. Valores válidos: Default: A marca d'água é a padrão. NotDefault: A marca d'água não é a padrão.
Name	String	Teste de marca d'água de texto	O nome da marca d'água.
Type	String	Text	O tipo da marca d'água. Valores válidos: Image: Este é o valor padrão. Text
WatermarkConfig	String	{"FontColor": "Blue","FontSize": 80, "Content": "Watermark test" }	As configurações, como posição e efeito da marca d'água de texto ou de imagem. O valor é uma string formatada em JSON. Nota O valor deste parâmetro varia conforme o tipo de marca d'água. Para obter mais informações sobre a estrutura de dados, consulte a seção "WatermarkConfig" do tópico Parâmetros de processamento de mídia.
WatermarkId	String	9bcc8bfadb84*****109a2671d0df97	O ID da marca d'água.

Exemplos

Exemplos de solicitações

https://vod.{ApiRegion}.aliyuncs.com/?Action=AddWatermark
&Name=Watermark
&Type=Text
&WatermarkConfig={"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<AddWatermarkResponse>
  <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
  <WatermarkInfo>
        <IsDefault>NotDefault</IsDefault>
        <FileUrl>https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&amp;OSSAccessKeyId=****&amp;Signature=gmf1eYMoDVg%2BHQCb4UGozBW****</FileUrl>
        <Type>Text</Type>
        <WatermarkId>9bcc8bfadb84*****109a2671d0df97</WatermarkId>
        <CreationTime>2018-11-07T09:05:52Z</CreationTime>
        <WatermarkConfig>{"FontColor": "Blue","FontSize": 80, "Content": "Watermark test" }</WatermarkConfig>
        <Name>Text watermark test</Name>
  </WatermarkInfo>
</AddWatermarkResponse>

Formato JSON

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "WatermarkInfo": {
        "IsDefault": "NotDefault",
        "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
        "Type": "Text",
        "WatermarkId": "9bcc8bfadb84*****109a2671d0df97",
        "CreationTime": "2018-11-07T09:05:52Z",
        "WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80, \"Content\": \"Watermark test\" }",
        "Name": "Text watermark test"
    }
}

Códigos de erro

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

Erros comuns

A tabela a seguir descreve os erros comuns que esta operação pode retornar.

Código de erro	Mensagem de erro	Código de status HTTP	Descrição
NoSuchResource	The specified resource %s does not exist.	404	A mensagem de erro retornada porque o recurso relacionado ao usuário não existe. %s indica as informações específicas do recurso.

Exemplos de SDK

Recomendamos o uso dos SDKs de servidor para chamar esta operação. Visualize o código de exemplo em diferentes linguagens para chamar esta operação clicando nos links a seguir: