ウォーターマークテンプレートの検索 - MPS

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

操作説明

返されるエントリの合計数です。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageSize	integer	任意	1 ページあたりのエントリ数です。 1 ページあたり最大 100 エントリを返すことができます。デフォルト値： 10。	10
PageNumber	integer	任意	ページ番号です。デフォルト値： 1。	1
State	string	任意	検索対象のウォーターマークテンプレートの状態です。有効な値は以下のとおりです。 All (デフォルト) Normal Deleted	Normal

レスポンスフィールド

フィールド	型	説明	例
	object	ウォーターマークテンプレートの詳細情報です。
TotalCount	integer	ウォーターマークの種類です。有効な値は以下のとおりです。 Image：画像ウォーターマーク。 Text：テキストウォーターマーク。説明サポートされているのは、Image 型のウォーターマークのみです。	1
PageSize	integer	Height、Width、Dx、Dy パラメーターの値が、基準となるエッジに対してどのように解釈されるかを指定します。Height、Width、Dx、Dy の値が 0 ～ 1 の小数である場合、以下の順序で各エッジを参照して計算されます。 Width：幅方向のエッジ。 Height：高さ方向のエッジ。 Long：長い辺。 Short：短い辺。	10
RequestId	string	リクエストの ID です。	FC029D04-8F47-57FF-A759-23383C15617D
PageNumber	integer	出力動画におけるウォーターマーク画像の幅です。値は整数または小数で指定できます。整数：ウォーターマーク画像の絶対的な幅（ピクセル単位）を表します。小数：ウォーターマーク画像の幅を、出力動画の幅に対する比率で表します。比率は動画サイズに応じて変化し、小数点以下 4 桁までサポートされます（例：0.9999）。それより多い桁数は切り捨てられます。	1
WaterMarkTemplateList	object
WaterMarkTemplate	array<object>	出力動画におけるウォーターマーク画像の高さです。値は整数または小数で指定できます。整数：ウォーターマーク画像の絶対的な高さ（ピクセル単位）を表します。小数：ウォーターマーク画像の高さを、出力動画の高さに対する比率で表します。比率は動画サイズに応じて変化し、小数点以下 4 桁までサポートされます（例：0.9999）。それより多い桁数は切り捨てられます。
	array<object>	ウォーターマークの出力動画に対する垂直方向のオフセットです。デフォルト値： 0（オフセットなし）。値は整数または小数で指定できます。整数：垂直方向の絶対的なオフセット（ピクセル単位）を表します。小数：垂直方向のオフセットを、出力動画の高さに対する比率で表します。比率は動画サイズに応じて変化し、小数点以下 4 桁までサポートされます（例：0.9999）。それより多い桁数は切り捨てられます。
Type	string	ウォーターマークの配置位置です。有効な値は以下のとおりです。 TopRight：右上隅。 TopLeft：左上隅。 BottomRight：右下隅。 BottomLeft：左下隅。	Image
RatioRefer	object	ウォーターマークテンプレートのステータスです。有効な値は以下のとおりです。 Normal：ウォーターマークテンプレートが正常です。 Deleted：ウォーターマークテンプレートが削除されています。
Dx	string	水平方向のオフセットです。単位：ピクセル。	0.51
Width	string	ウォーターマーク画像の幅です。単位：ピクセル。	0.36
Height	string	ウォーターマーク画像の高さです。単位：ピクセル。	0.33
Dy	string	ウォーターマークのタイムラインです。	0.2
ReferPos	string	ウォーターマークの表示開始時刻です。単位：秒。デフォルト値： 0。	TopRight
State	string	ウォーターマークの表示継続時間です。デフォルト値： ToEND（動画終了まで表示）。	Normal
Dx	string	ウォーターマークテンプレートの名前です。	100
Width	string	垂直方向のオフセットです。単位：ピクセル。	8
Height	string	ウォーターマークテンプレートの ID です。	8
Timeline	object	ウォーターマークのタイムラインです。
Start	string	返されるエントリの合計数です。	0
Duration	string	出力動画に対するウォーターマークの水平方向のオフセットです。デフォルト値： 0（オフセットなし）。値は整数または小数で指定できます。整数：水平方向の絶対的なオフセット（ピクセル単位）を表します。小数：水平方向のオフセットを、出力動画の幅に対する比率で表します。比率は動画サイズに応じて変化し、小数点以下 4 桁までサポートされます（例：0.9999）。それより多い桁数は切り捨てられます。	ToEND
Name	string	出力動画におけるウォーターマーク画像の幅です。値は整数または小数で指定できます。整数：ウォーターマーク画像の絶対的な幅（ピクセル単位）を表します。小数：ウォーターマーク画像の幅を、出力動画の幅に対する比率で表します。比率は動画サイズに応じて変化し、小数点以下 4 桁までサポートされます（例：0.9999）。それより多い桁数は切り捨てられます。	example-watermark
Dy	string	Height、Width、Dx、Dy パラメーターの値が、基準となるエッジに対してどのように解釈されるかを指定します。Height、Width、Dx、Dy の値が 0 ～ 1 の小数である場合、以下の順序で各エッジを参照して計算されます。 Width：幅方向のエッジ。 Height：高さ方向のエッジ。 Long：長い辺。 Short：短い辺。	100
Id	string	垂直方向のオフセットです。単位：ピクセル。	88c6ca184c0e4578645b665e2a12****

例

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "FC029D04-8F47-57FF-A759-23383C15617D",
  "PageNumber": 1,
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.2"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "ToEND"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "88c6ca184c0e4578645b665e2a12****"
      }
    ]
  }
}

エラーコード

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

変更履歴

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