ウォーターマークテンプレートの一括取得 - MPS

ウォーターマークテンプレートをクエリします。

操作説明

この操作を呼び出すことで、一度に最大 10 個のウォーターマークテンプレートをクエリできます。

QPS 制限

この操作は、アカウントあたり 1 秒間に最大 100 回呼び出すことができます。この制限を超えるリクエストはドロップされ、サービス中断が発生する可能性があります。この操作を呼び出す際には、この制限にご注意ください。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mts:QueryWaterMarkTemplateList

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
WaterMarkTemplateIds	string	必須	クエリ対象のウォーターマークテンプレートの ID です。ApsaraVideo Media Processing (MPS) コンソールにログインし、左側のナビゲーションウィンドウで [グローバル設定] > [ウォーターマークテンプレート] を選択することで、ウォーターマークテンプレートの ID を取得できます。一度に最大 10 個のウォーターマークテンプレートをクエリできます。複数のウォーターマークテンプレート ID はコンマ (,) で区切って指定してください。	3780bd69b2b74540bc7b1096f564****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエストの ID です。	17079AF5-6276-51A9-B755-D26594C93F3C
NonExistWids	object
String	array	存在しないテンプレートの ID です。
	string	存在しないウォーターマークテンプレートの ID です。指定されたすべてのウォーターマークテンプレートが見つかった場合は、このパラメーターは返されません。	72dfa5e679ab4be9a3ed9974c736****
WaterMarkTemplateList	object
WaterMarkTemplate	array<object>	ウォーターマークテンプレートの詳細情報です。
	array<object>	レスポンスパラメーターです。
Type	string	ウォーターマークのタイプです。有効な値は以下のとおりです。 Image：画像ウォーターマーク。 Text：テキストウォーターマーク。説明 Image タイプのウォーターマークのみサポートされています。	Image
RatioRefer	object	Height、Width、Dx、および Dy パラメーターの値が参照する基準となる辺です。Height、Width、Dx、および Dy パラメーターの値が 0 ～ 1 の間の小数である場合、以下の順序で辺を参照して計算されます。 Width：幅の辺。 Height：高さの辺。 Long：長い辺。 Short：短い辺。
Dx	string	出力動画画像に対するウォーターマークの水平方向オフセットです。デフォルト値は 0 です。デフォルト値はオフセットなしを示します。値は整数または小数で指定できます。整数：垂直方向オフセット（絶対位置）。単位はピクセルです。小数：出力動画の幅に対する水平方向オフセットの比率です。動画のサイズによって比率が変化します。小数点以下 4 桁までサポートされており（例：0.9999）、それ以上の桁は切り捨てられます。	0.51
Width	string	出力動画におけるウォーターマーク画像の幅です。値は整数または小数で指定できます。整数：ウォーターマーク画像の幅（絶対位置）。単位はピクセルです。小数：出力動画の幅に対するウォーターマーク画像の幅の比率です。動画のサイズによって比率が変化します。小数点以下 4 桁までサポートされており（例：0.9999）、それ以上の桁は切り捨てられます。	0.36
Height	string	出力動画におけるウォーターマーク画像の高さです。値は整数または小数で指定できます。整数：ウォーターマーク画像の高さ（絶対位置）。単位はピクセルです。小数：出力動画の高さに対するウォーターマーク画像の高さの比率です。動画のサイズによって比率が変化します。小数点以下 4 桁までサポートされており（例：0.9999）、それ以上の桁は切り捨てられます。	0.33
Dy	string	出力動画画像に対するウォーターマークの垂直方向オフセットです。デフォルト値は 0 です。デフォルト値はオフセットなしを示します。値は整数または小数で指定できます。整数：垂直方向オフセット（絶対位置）。単位はピクセルです。小数：出力動画の高さに対する垂直方向オフセットの比率です。動画のサイズによって比率が変化します。小数点以下 4 桁までサポートされており（例：0.9999）、それ以上の桁は切り捨てられます。	0.4
ReferPos	string	ウォーターマークの位置です。有効な値は以下のとおりです。 TopRight：右上隅。 TopLeft：左上隅。 BottomRight：右下隅。 BottomLeft：左下隅。	TopRight
State	string	ウォーターマークテンプレートのステータスです。有効な値は以下のとおりです。 Normal：ウォーターマークテンプレートは正常です。 Deleted：ウォーターマークテンプレートは削除済みです。	Normal
Dx	string	水平方向オフセットです。単位はピクセルです。	100
Width	string	ウォーターマーク画像の幅です。単位はピクセルです。	8
Height	string	ウォーターマーク画像の高さです。単位はピクセルです。	8
Timeline	object	ウォーターマークのタイムラインです。
Start	string	ウォーターマークが表示される時間範囲の開始時刻です。単位：秒。デフォルト値：0。	0
Duration	string	ウォーターマークの表示期間です。デフォルト値は ToEND です。デフォルト値は、動画の終了までウォーターマークが表示されることを示します。	10
Name	string	ウォーターマークテンプレートの名前です。	example-watermark
Dy	string	垂直方向オフセットです。単位はピクセルです。	100
Id	string	ウォーターマークテンプレートの ID です。	3780bd69b2b74540bc7b1096f564****

例

成功レスポンス

JSONJSON

{
  "RequestId": "17079AF5-6276-51A9-B755-D26594C93F3C",
  "NonExistWids": {
    "String": [
      "72dfa5e679ab4be9a3ed9974c736****"
    ]
  },
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.4"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "10"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "3780bd69b2b74540bc7b1096f564****"
      }
    ]
  }
}

エラーコード

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

変更履歴

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