BatchSetLiveDomainConfigs による一括ライブドメイン設定 - LIVE - Alibaba Cloud - ApsaraVideo Live

操作説明

設定するライブストリーミングドメイン名を取得し、この操作を呼び出してドメイン名をバッチで設定します。

QPS 制限

この操作のユーザーあたりの 1 秒あたりのクエリ数 (QPS) の最大値は 30 です。制限を超えると、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:BatchSetLiveDomainConfigs

update

*Domain。

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DomainNames	string	必須	バッチで設定するドメイン名。値には、アップストリーミングドメイン、プライマリストリーミングドメイン、またはセカンダリストリーミングドメインを指定できます。複数のドメイン名はコンマ (,) で区切ります。	demo.aliyundoc.com,example.aliyundoc.com,example.com
Functions	string	必須	特徴のリスト。 `filetype_based_ttl_set` などの一部の特徴は、複数の Record をサポートしています。特定の Record を更新するには、その Record の `configId` を指定します。詳細については、以下の関数フォーマットの説明および関数特徴の説明の表を参照してください。	[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]
DryRun	boolean	任意	ドライランのみを実行し、実際に操作を実行しないかどうかを指定します。有効な値: true: ドライランリクエストを送信します。リクエストが検証に合格しても、操作は実際には実行されません。 false (デフォルト): 通常のリクエストを送信します。リクエストが検証に合格すると、操作が実際に実行されます。ドライランでは、パラメーターの有効性、RAM 権限、およびリソースのステータスが検証されます。ドライランに失敗すると、対応するエラーコードが返されます。ドライランに成功しても、操作は実際には実行されません。	false

関数フォーマットの説明

例: [{"functionArgs":[{"argName":"ドメイン名","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}]
filetype_based_ttl_set などの一部の特徴は、複数の Record をサポートしています。特定の Record を更新するには、その Record の configId を指定します。例: [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]

関数特徴のフォーマット説明

名前	パラメーター
referer_white_list_set: Referer ホワイトリスト。	refer_domain_allow_list: ホワイトリスト。複数の値はコンマ (,) で区切ります。 allow_empty: 空の Referer を許可するかどうかを指定します。有効な値: on または off。
referer_black_list_set: Referer ブラックリスト。	refer_domain_deny_list: ブラックリスト。複数の値はコンマ (,) で区切ります。 allow_empty: 空の Referer を許可するかどうかを指定します。有効な値: on または off。
filetype_based_ttl_set: ファイルの有効期限設定。	ttl: キャッシュ時間。単位: 秒。有効な値: 1～99999999 (3 年強)。 file_type: ファイルタイプ。複数の値はコンマ (,) で区切ります。 weight: 重み。有効な値: 1～99。
path_based_ttl_set: ディレクトリの有効期限設定。	ttl: キャッシュ時間。単位: 秒。有効な値: 1～99999999 (3 年強)。 path: ディレクトリ。スラッシュ (/) で始まる必要があります。 weight: 重み。有効な値: 1～99。
oss_auth: OSS 認証バケット。	oss_bucket_id: ユーザーバケットのアドレス。
ip_black_list_set: IP ブラックリスト。	ip_list: IP リスト。複数の値はコンマ (,) で区切ります。
ip_allow_list_set: IP ホワイトリスト。	ip_list: IP リスト。複数の値はコンマ (,) で区切ります。
ip_white_list_set: アクセス頻度制御の免除。	ip_list: IP リスト。複数の値はコンマ (,) で区切ります。
error_page: エラーページのリダイレクト。	error_code: エラーコード。 rewrite_page: リダイレクトページ。
set_req_host_header: バックツーオリジンホストヘッダーの変更。	domain_name: バックツーオリジンホストヘッダーのコンテンツ。
set_hashkey_args: URL パラメーターの無視。	hashkey_args: 保持するパラメーターのリスト。複数の値はコンマ (,) で区切ります。 disable: すべてのパラメーターを無視するかどうかを指定します。有効な値: on (すべてのパラメーターを無視) または off (無視しない)。
aliauth: Alibaba Cloud 認証。	auth_type: 認証タイプ。有効な値: type_a (認証タイプ A)、no_auth (認証の無効化)。 auth_key1: 認証キー 1。キーは大文字、小文字、数字をサポートします。長さは 8～32 文字に設定することを推奨します。 auth_key2: 認証キー 2。 ali_auth_delta: カスタム認証バッファー時間。単位: 秒。最小値は 60 秒を推奨します。上限はありません。 auth_m3u8: M3U8 コンテンツの書き換えを有効にするかどうかを指定します。これにより、M3U8 ファイル内の TS セグメントに認証情報が追加され、TS アクセス認証の失敗を防ぎます。有効な値: on (デフォルト) または off。
remote_auth: ライブストリームリモート認証。	enable: リモート認証を有効にするかどうかを指定します。このパラメーターは必須です。有効な値: on または off。 remote_auth_path: 認証サーバーのアドレス。このパラメーターは必須です。 remote_auth_pattern: 認証モード文字列。次の設定が利用可能です。 - param: アップストリーミング URL 内のパラメーターを認証サーバーにパススルーするかどうかを指定します。有効な値: pass (デフォルト) または fail。 - args_white: パススルーする指定パラメーター。複数のパラメーターはコンマ (,) で区切ります。 - args_black: パススルーしない指定パラメーター。複数のパラメーターはコンマ (,) で区切ります。 - code: 認証ステータスコード。code=XXX は、認証成功時に認証サーバーから ApsaraVideo Live に返される HTTP ステータスコードを指定します。例: code=200。code=~XXX は、認証失敗時に返される HTTP ステータスコードを指定します。例: code=~403。 - delta: 認証タイムアウト期間。 - retry: 認証タイムアウト時の再試行回数。 - timeout: 認証タイムアウト時の動作。有効な値: pass または fail。pass: ApsaraVideo Live はユーザーリクエストを直接パススルーします。fail: ApsaraVideo Live はユーザーに認証失敗ステータスコード (403) を応答します。 - async: 非同期認証。有効な値: on (非同期認証を有効化) または off (デフォルト、非同期認証を無効化)。
set_resp_header: レスポンスヘッダーの設定 (ブラウザー側で表示可能)。	key: レスポンスヘッダー。有効な値: Content-Type. Cache-Control. Content-Disposition. Content-Language. Expires. Access-Control-Allow-Origin. Access-Control-Allow-Methods. Access-Control-Allow-Headers. Access-Control-Max-Age. Access-Control-Expose-Headers. value: レスポンスヘッダーのコンテンツ。ヘッダーを削除するには、これを null に設定します。
https_force: HTTPS リダイレクトの強制。	enable: 特徴のスイッチ。有効な値: on または off。https_force と http_force は互いに排他的です。一度に存在できるのはどちらか一方のみです。もう一方を設定するには、まず既存の設定を削除します。
http_force: HTTP リダイレクトの強制。	enable: 特徴のスイッチ。有効な値: on または off。https_force と http_force は互いに排他的です。一度に存在できるのはどちらか一方のみです。もう一方を設定するには、まず既存の設定を削除します。
forward_scheme: アダプティブバックツーオリジン。	enable: 特徴のスイッチ。有効な値: on または off。 scheme_origin: バックツーオリジンプロトコル (http、https、または follow)。 scheme_origin_port: バックツーオリジンプロトコルポート (80、443、または 80:443)。
green_manager: コンテンツモデレーション。	enable: コンテンツモデレーションを有効にするかどうかを指定します。有効な値: on または off。
tmd_signature: カスタムアクセス頻度制御ルール。	name: ルール名。ドメイン内で一意である必要があります。 path: 繰り返し可能です。URI パスの有効性が検証されます。 pathType: 一致ルール。0: プレフィックス一致。1: 完全一致。 interval: 監視期間。単位: 秒。値は 10 以上である必要があります。 count: 単一 IP アドレスからの訪問数。 action: ブロックタイプ。0: ブロック。1: 人間と機械の識別。 ttl: ブロック期間。単位: 秒。
l2_oss_key: L2 OSS バックツーオリジン秘密鍵。	private_oss_auth: プライベート OSS 認証を有効にするかどうかを指定します。有効な値: on または off。
video_seek: ビデオスライスシークスイッチ。	enable: 特徴のスイッチ。有効な値: on または off。
gzip: ページ Gzip 最適化。	enable: 特徴のスイッチ。有効な値: on または off。
tesla: ページ最適化アクセラレーション。	enable: 特徴のスイッチ。有効な値: on または off。
ali_ua: User-Agent アクセス制限。	ua: User-Agent。 type: リストタイプ。有効な値: black または white。
host_redirect: 書き換え特徴。	regex: 書き換える URL。例: ^/$。 replacement: ターゲット URL。例: /go/act/sale/tbzlsy.php。 flag: redirect または break のみがサポートされています。
ipv6: IPv6 設定。	switch: スイッチ (必須)。有効な値: on または off。有効にした後、無効にするには、設定を削除するのではなくオプションの選択を解除します。そうしないと、変更は効果が出ません。 region: IPv6 が有効なリージョン。有効な値: cn-beijing (北京)、cn-shanghai (上海)、cn-shenzhen (深セン)、cn-qingdao (青島)、apsoutheast-1 (シンガポール)、eu-central-1 (ドイツ)、ap-northeast-1 (東京)、ap-southeast-5 (ジャカルタ)。
ali_location: リージョンベースのアクセス制限。	location: リージョンリスト。 type: リストタイプ。有効な値: black または white。
cc_defense: CC 攻撃対策。	enable: CC 攻撃対策保護を有効または無効にします。有効な値: on または off。
alilive: ApsaraVideo Live 設定。	notify_url: ライブストリーム通知 URL。 enable: 特徴のスイッチ。有効な値: on または off。 live_forbid_flv: FLV 再生を禁止するかどうかを指定します。有効な値: on または off。 live_forbid_rtmp: RTMP 再生を禁止するかどうかを指定します。有効な値: on または off。 live_forbid_hls: HLS 再生を禁止するかどうかを指定します。有効な値: on または off。
ali_grtn: GRTN サービスアクセススイッチ。	grtn_rts_pub: RTS ストリームアップストリーミングスイッチ。アップストリーミングドメインに使用されます。有効な値: on または off。 grtn_rts_play: RTS ストリーミングスイッチ。ストリーミングドメインに使用されます。有効な値: on または off。 grtn_rts_transcode: RTS H5 再生自動トランスコーディングスイッチ。有効な値: on または off。
edge_function: エッジ関数。	必須パラメーター: rule: DSL ルール。 pri: 優先度。 enable: このルールを有効にするかどうかを指定します。有効な値: on または off。オプションパラメーター: name: ルール名。 pos: ルール実行位置。 brk: このルールに一致した場合、現在の実行位置にある残りのルールはスキップされます。 option: オプション制御。 grammar: 構文制御。有効な値: empty、es2、または js。 jsmode: JS ドメインホワイトリスト制御。有効な値: redirect または bypass。
https_tls_version: TLS プロトコルバージョン。	tls10: TLSv1.0 を有効にします。デフォルト値: on。有効な値: on または off。 tls11: TLSv1.1 を有効にします。デフォルト値: on。有効な値: on または off。 tls12: TLSv1.2 を有効にします。デフォルト値: on。有効な値: on または off。 tls13: TLSv1.3 を有効にします。デフォルト値: on。有効な値: on または off。
https_option: HTTP プロトコル設定。	http2: HTTP/2 を有効にするかどうかを指定します。デフォルト値: off。有効な値: on または off。 live_http2: live_http2 を有効にするかどうかを指定します。デフォルト値: off。有効な値: on または off。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidFunctions.Malformed	Specified Functions is malformed.
400	InvalidFunctionArgs.Malformed	The specified FunctionArgs is invalid.
400	InvalidArgValue.Malformed	Specified ArgValue is malformed.
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.
400	Invalid%s.Malformed	ArgValue [%s] is malformed.
400	MissingParameter%s	The specified value of ArgName[%s] is missing.
400	FunctionMutex	Function is mutex with other function.
400	RewriteHostRely	Domain name is configured as rewrite host by others.
400	ConfigurationConflicts	The staging environment has a configuration in effect and cannot modify the production environment configuration.	カナリアリリース環境にアクティブな構成があります。本番環境の環境構成を変更することはできません。

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

変更履歴

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