すべてのプロダクト
Search
ドキュメントセンター

ApsaraVideo VOD:AddWatermark

最終更新日:Jul 21, 2026

イメージまたはテキストのウォーターマークテンプレートを追加します。ウォーターマークタスクの処理を簡素化するため、ApsaraVideo VOD は位置、サイズ、フォント、色などの複雑なウォーターマークパラメーターをテンプレートに統合し、各テンプレートは一意のウォーターマークテンプレート ID で識別されます。

操作説明

  • この操作を呼び出して、イメージウォーターマークテンプレート (Image) またはテキストウォーターマークテンプレート (Text) を追加します。イメージウォーターマークテンプレートは、静的イメージ (PNG) およびアニメーションイメージ (GIF、APNG、MOV) のフォーマットをサポートしています。

  • この操作を呼び出してウォーターマークテンプレートを追加した後、 AddTranscodeTemplateGroup または UpdateTranscodeTemplateGroup を呼び出して、ウォーターマークテンプレートをトランスコーディングテンプレートグループに関連付け、後続のウォーターマークのトランスコード中を実行します。

  • 動画へのイメージおよびテキストウォーターマークの追加の詳細については、「動画のウォーターマーク」を参照してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vod:AddWatermark

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Type

string

必須

ウォーターマークのテンプレートタイプ。有効な値:

  • Image (デフォルト): イメージウォーターマークテンプレート。

  • Text: テキストウォーターマークテンプレート。

Image。

Name

string

必須

ウォーターマークテンプレートの名前。

  • 漢字、英字、数字のみ使用できます。

  • 名前の長さは最大 128 バイトです。

  • UTF-8 エンコーディング。

画像ウォーターマークテンプレート。

WatermarkConfig

string

必須

ウォーターマークの構成情報 (JSON 文字列)。ウォーターマークの表示位置や効果などが含まれます。構成パラメーターはイメージウォーターマークとテキストウォーターマークで異なります。パラメーター構造の詳細については、「 WatermarkConfig 」を参照してください。

{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }

FileUrl

string

任意

ウォーターマークイメージファイルの Object Storage Service (OSS) URL (認証なし)。

説明
  • イメージウォーターマークテンプレート (TypeImage) をセットする場合、このリクエストパラメーターは必須です。

  • CreateUploadAttachedMedia を呼び出して、ウォーターマークイメージを ApsaraVideo VOD にアップロードできます。アップロード後に返される FileURL パラメーターの値を、このリクエストパラメーターの値として使用できます。

http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png

AppId

string

任意

アプリケーション ID。デフォルト値: app-1000000。マルチアプリケーションサービスを有効にしている場合、アプリケーション ID を指定して、指定したアプリケーションにウォーターマークテンプレートを追加できます。詳細については、「マルチアプリケーションサービス」を参照してください。

app-****

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

25818875-5F78-4A*****F6-D7393642CA58

WatermarkInfo

object

ウォーターマークテンプレート情報。

CreationTime

string

ウォーターマークテンプレートが作成された時間。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) です。

2018-11-07T09:05:52Z

Type

string

ウォーターマークテンプレートのタイプ。有効な値:

  • Image: イメージウォーターマークテンプレート。

  • Text: テキストウォーターマークテンプレート。

Image。

IsDefault

string

ウォーターマークテンプレートがデフォルトテンプレートかどうかを示します。有効な値:

  • Default: デフォルトのウォーターマークテンプレート。

  • NotDefault: デフォルトのウォーターマークテンプレートではない。

NotDefault。

FileUrl

string

ウォーターマークファイルの URL (OSS URL または CDN URL)。

説明

このパラメーターはイメージウォーターマークテンプレートに対してのみ返されます。

https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****

WatermarkConfig

string

ウォーターマークの構成情報 (JSON 文字列)。ウォーターマークの表示位置や効果などが含まれます。構成パラメーターはイメージウォーターマークとテキストウォーターマークで異なります。パラメーター構造の詳細については、「 WatermarkConfig 」を参照してください。

{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }

Name

string

ウォーターマークテンプレートの名前。

画像ウォーターマークテンプレート。

WatermarkId

string

ウォーターマークテンプレートの ID。このウォーターマークテンプレート ID を使用して、テンプレートをトランスコーディングテンプレートグループに関連付けたり、テンプレートのクエリ、変更、削除、またはデフォルトのウォーターマークテンプレートとしてのセットを行ったりできます。

9bcc8bfadb84*****109a2671d0df97

成功レスポンス

JSONJSON

{
  "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": "图片水印模板",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。