すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:ListWatermark

    ドキュメントセンター

    ApsaraVideo VOD:ListWatermark

    最終更新日:Dec 15, 2025

    指定されたリージョン内のすべてのイメージウォーターマークテンプレートとテキストウォーターマークテンプレートの設定情報をクエリします。この操作を呼び出すことで、イメージウォーターマークの位置、サイズ、表示時間や、テキストウォーターマークのコンテンツ、位置、フォント、フォントカラーなどの情報を取得できます。

    今すぐお試しください

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

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AppId

    string

    任意

    アプリケーションの ID。デフォルト値：app-1000000。

    マルチアプリケーションサービスを有効化している場合は、アプリケーション ID を指定して、指定したアプリケーション内のすべてのイメージウォーターマークテンプレートとテキストウォーターマークテンプレートをクエリします。このパラメーターを空のままにすると、すべてのアプリケーションのイメージウォーターマークテンプレートとテキストウォーターマークテンプレートがクエリされます。詳細については、「概要」をご参照ください。

    app-****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    array<object>

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

    object

    CreationTime

    string

    ウォーターマークテンプレートが作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。

    2018-11-07T09:05:52Z
    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-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****
    AppId

    string

    アプリケーションの ID。

    app-****
    WatermarkConfig

    string

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

    {"FontColor": "Blue","FontSize": 80,"Content": "test watermark"}
    Name

    string

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

    testName
    WatermarkId

    string

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

    9bcc8bfadb843*****109a2671d0df97

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfos": [
    {
      "CreationTime": "2018-11-07T09:05:52Z",
      "Type": "Text",
      "IsDefault": "NotDefault",
      "FileUrl": "https://outin-3262681cd*****89f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/8CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozB****",
      "AppId": "app-****",
      "WatermarkConfig": "{\"FontColor\": \"Blue\",\"FontSize\": 80,\"Content\": \"test watermark\"}",
      "Name": "testName",
      "WatermarkId": "9bcc8bfadb843*****109a2671d0df97"
    }
  ]
}

    エラーコード

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

    変更履歴

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