DescribeLiveStreamWatermarks - - Alibaba Cloud ドキュメントセンター

DescribeLiveStreamWatermarks 操作を呼び出して、ウォーターマークテンプレートのリストをクエリできます。

操作説明

この操作はページングをサポートしています。必要に応じてパラメーターを設定できます。

QPS 制限

1 ユーザーあたりのクエリ/秒 (QPS) 制限は、1 秒あたり 60 呼び出しです。制限を超えると、API 呼び出しがスロットルされ、ビジネスに影響を与える可能性があります。この操作は適切なレートで呼び出してください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:DescribeLiveStreamWatermarks

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
Domain	string	任意	ストリーミングドメイン。	live.yourdomain.com
KeyWord	string	任意	検索キーワード。テンプレート ID または名前を指定できます。名前にはあいまい検索がサポートされています。	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNumber	integer	任意	ページ番号。デフォルト値は 1 です。	1
PageSize	integer	任意	各ページに返すテンプレートの数。デフォルト値は 100 です。	100

レスポンスフィールド

フィールド	型	説明	例
	object	ウォーターマークテンプレート情報。
Total	integer	一致するエントリの総数。	100
RequestId	string	リクエスト ID。	5c6a2a0df228-4a64- af62-20e91b9676b3
WatermarkList	object
Watermark	array<object>	ウォーターマークテンプレートのリスト。
	object	ウォーターマークテンプレートのリスト。
Type	integer	ウォーターマークタイプ。 0: 画像。画像ウォーターマークのみがサポートされています。 1: テキスト。	0
XOffset	number	ウォーターマークの x 軸オフセット (ピクセル単位 (px))。説明オフセットは、基準となる背景 (RefWidth) の幅に対する相対値です。OffsetCorner を TopLeft に設定した場合、XOffset は背景ビデオの左上隅からウォーターマーク画像の左上隅までの水平方向の距離を指定します。x 軸の正方向は右方向です。	50.0
RefWidth	integer	基準となる背景ビデオの幅 (ピクセル単位 (px))。	1920
YOffset	number	ウォーターマークの y 軸オフセット (ピクセル単位 (px))。説明オフセットは、基準となる背景 (RefHeight) の高さに対する相対値です。OffsetCorner を TopLeft に設定した場合、YOffset は背景ビデオの左上隅からウォーターマーク画像の左上隅までの垂直方向の距離を指定します。y 軸の正方向は下方向です。	100.0
Height	integer	ウォーターマーク画像の高さ (ピクセル単位 (px))。	200
RefHeight	integer	基準となる背景ビデオの高さ (ピクセル単位 (px))。	1080
PictureUrl	string	ウォーターマーク画像の URL。	http://example.com
Transparency	integer	ウォーターマークの透明度。値が小さいほど透明度が高くなります。有効な値: 0 ～ 255。	255
Description	string	ウォーターマークのカスタム記述。	my watermark
OffsetCorner	string	ウォーターマークの位置。 TopLeft: 左上 TopRight: 右上 BottomLeft: 左下 BottomRight: 右下	TopRight
RuleCount	integer	ドメインに設定されているウォーターマークルールの数。	12
Name	string	ウォーターマークの名前。	livewatermark****
TemplateId	string	ウォーターマークテンプレートの ID。	445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

例

成功レスポンス

JSONJSON

{
  "Total": 100,
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "WatermarkList": {
    "Watermark": [
      {
        "Type": 0,
        "XOffset": 50,
        "RefWidth": 1920,
        "YOffset": 100,
        "Height": 200,
        "RefHeight": 1080,
        "PictureUrl": "http://example.com",
        "Transparency": 255,
        "Description": "my watermark",
        "OffsetCorner": "TopRight",
        "RuleCount": 12,
        "Name": "livewatermark****",
        "TemplateId": "445409ec-7eaa-4 61d-8f29-4bec2eb9 ****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameters	%s Please check and try again later.

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

変更履歴

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