API によるウォーターマークテンプレート名と設定の変更 - ApsaraVideo VOD (VOD)

操作説明

AddWatermark 操作を呼び出してウォーターマークテンプレートを作成した後、そのテンプレートの名前と構成を変更できます。
この操作を呼び出して、イメージウォーターマークテンプレート内のイメージを変更することはできません。

今すぐお試しください

この 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:UpdateWatermark

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	任意	変更するウォーターマークテンプレートの名前。英数字のみをサポートしています。名前は 128 バイトを超えることはできません。値は UTF-8 でエンコードする必要があります。	test
WatermarkId	string	必須	ウォーターマークテンプレートの ID。指定できるウォーターマークテンプレート ID は 1 つだけです。ID は、次のいずれかの方法で取得できます。 AddWatermark 操作を呼び出してウォーターマークテンプレートを作成する際の応答からウォーターマークテンプレート ID を取得します。アカウント内のすべてのウォーターマークテンプレートをクエリするために呼び出す ListWatermark 操作の応答からウォーターマークテンプレート ID を取得します。	af2afe4761992c*****bd947dae97337
WatermarkConfig	string	必須	表示位置や特殊効果などのウォーターマークの構成情報。値は JSON 文字列である必要があります。イメージウォーターマークとテキストウォーターマークの構成パラメーターは異なります。パラメーター構造の詳細については、「WatermarkConfig」をご参照ください。	{"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft","Type":"Image"}

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	ウォーターマークテンプレートの情報。
CreationTime	string	ウォーターマークテンプレートが作成された時間。時間は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時間は UTC で表示されます。	2018-11-06T08:03:17Z
Type	string	ウォーターマークテンプレートのタイプ。 Image：イメージウォーターマークテンプレート Text：テキストウォーターマークテンプレート	Text
IsDefault	string	ウォーターマークテンプレートがデフォルトであるかどうかを示します。 Default NotDefault	NotDefault
FileUrl	string	ウォーターマークファイルの URL。URL は Object Storage Service (OSS) の URL または Alibaba Cloud CDN の URL です。説明このパラメーターは、イメージウォーターマークテンプレートの場合にのみ返されます。	https://outin-32**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":"BottonLeft","Type":"Image"}
Name	string	ウォーターマークテンプレートの名前。	image watermark test
WatermarkId	string	ウォーターマークテンプレートの ID。	505e2e287ea*****ecfddd386d384

例

成功レスポンス

JSONJSON

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-06T08:03:17Z",
    "Type": "Image",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-32****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\"Width\":\"55\",\"Height\":\"55\",\"Dx\":\"9\",\"Dy\":\"9\",\"ReferPos\":\"BottomLeft\"}",
    "Name": "test",
    "WatermarkId": "505e2e287ea*****ecfddd386d384"
  }
}

エラーコード

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

変更履歴

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