すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:BatchSetLiveDomainConfigs

    ドキュメントセンター

    ApsaraVideo Live:BatchSetLiveDomainConfigs

    最終更新日:Oct 10, 2024

    ドメイン名をバッチで設定します。

    使用状況ノート

    ドメイン名は、このAPIを呼び出すために必須です。

    QPS制限

    1人のユーザーが1秒あたり最大30件のクエリ (QPS) を実行できます。 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 スロットルはビジネスに影響を与える可能性があります。 したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    パラメーターデータ型必須／任意例説明
    操作String必須BatchSetLiveDomainConfigs

    実行する操作です。 値をBatchSetLiveDomainConfigsに設定します。

    ドメイン名String必須demo.aliyundoc.com,example.aliyundoc.com,example.com

    ストリーミングドメイン。 複数のストリーミングドメインはコンマ (,) で区切ります。

    関数String必須 [{"functionArgs":"file_type","argValue":"jpg" },{ "argName":"ttl","argValue":"18" },{ "argName":"weight","argValue":"30"}] 、"functionName":"filetype_based_Id" *** "506

    機能リスト。

    filetype_based_ttl_setなどの一部の機能は、複数の構成レコードをサポートしています。 いずれかの設定レコードを更新するには、configIdフィールドを使用してレコードを指定します。 詳細については、「関数の形式」をご参照ください。

    関数の形式

    • 例: [{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}]
    • filetype_based_ttl_setなどの一部の機能は、複数の構成レコードをサポートします。 構成レコードの1つを更新するには、configIdフィールドを使用してレコードを指定します。 例: [{"functionArgs":"file_type","argValue":"jpg" },{ "argName":"ttl","argValue":"18" },{ "argName":"weight","argValue":"argValue":"30"}, "filetype_configxxx}," 50""

    機能

    機能

    説明

    referer_white_list_set: リファラーホワイトリストを指定します。

    refer_domain_allow_list: ホワイトリストに追加されるリファラー。 Separate multiple referers with commas (,).

    allow_empty: 空のリファラーを許可するかどうかを指定します。 Valid values: on and off.

    referer_black_list_set: リファラーブラックリストを指定します。

    refer_domain_deny_list: ブラックリストに追加されるリファラー。 複数のリファラーはコンマ (,) で区切ります。

    allow_empty: 空のリファラーを許可するかどうかを指定します。 有効な値: onとoff。

    filetype_based_ttl_set: ファイルの有効期限を指定します。

    ttl: キャッシュ期間。 (単位：秒)

    file_type: ファイルタイプ。 複数のファイルタイプはコンマ (,) で区切ります。

    weight: キャッシュ内のファイルの重み。 有効な値: 1 ~ 199

    path_based_ttl_set: ディレクトリの有効期限を指定します。

    ttl: キャッシュ期間。 (単位：秒)

    path: スラッシュ (/) で始まる必要があるディレクトリ。

    weight: キャッシュ内のディレクトリの重み。 Valid values: 1 to 99.

    oss_auth: Object Storage Service (oss) バケットへのアクセスのための認証を設定します。

    oss_bucket_id: OSSバケットのパス。

    ip_black_list_set: IPアドレスブラックリストを指定します。

    ip_list: ホワイトリストに追加されるipアドレス。 IP アドレスが複数ある場合はカンマ (,) で区切ります。

    ip_allow_list_set: specifies the IP address whitelist.

    ip_list: the IP addresses to be added to the whitelist. IP アドレスが複数ある場合はカンマ (,) で区切ります。

    ip_white_list_set: レート制限用のIPアドレスホワイトリストを指定します。

    ip_list: ホワイトリストに追加されるipアドレス。 IP アドレスが複数ある場合はカンマ (,) で区切ります。

    error_page: エラーページを指定したページにリダイレクトします。

    error_code: エラーコード。

    rewrite_page: エラーページのリダイレクト先のページ。

    set_req_host_header: back-to-originリクエストのホストヘッダーを変更します。

    domain_name: back-to-originリクエストのホストヘッダー。

    set_hashkey_args: ignores the specified URL parameters.

    hashkey_args: 予約するパラメーター。 複数のパラメーターはコンマ (,) で区切ります。

    disable: すべてのパラメーターを無視するかどうかを指定します。 onの値は、すべてのパラメーターが無視されることを示します。 offの値は、パラメータのどれも無視されないことを示す。

    aliauth: Alibaba Cloud認証を設定します。

    auth_type: 認証タイプ。 有効な値: type_aおよびno_auth。 type_aの値は、認証タイプAが有効であることを示します。 no_authの値は、認証が無効であることを示します。

    auth_key1: プライマリ認証キー。 認証キーの長さは16 ~ 32文字で、大文字、小文字、および数字を使用できます。

    auth_key2: セカンダリ認証キー。

    ali_auth_delta: 認証のカスタムバッファ時間。

    set_resp_header: レスポンスヘッダーを設定します。 設定を確認するには、応答メッセージをブラウザで確認します。

    key: レスポンスヘッダーの名前。 設定可能な値は以下のとおりです。

    Content-Type<br> キャッシュ制御

    コンテンツ処理

    コンテンツ言語

    有効期限

    アクセス制御-許可-オリジン

    アクセス制御-許可-メソッド

    アクセス制御-許可ヘッダー

    アクセス制御-Max-Age

    アクセス制御-公開ヘッダー

    value: レスポンスヘッダーの内容。 ヘッダーを削除する場合は、nullを入力します。

    https_force: httpsへの強制リダイレクトを設定します。

    enable: HTTPSへの強制リダイレクトを有効にするかどうかを指定します。 有効な値: onとoff。

    http_force: httpへの強制リダイレクトを設定します。

    enable: HTTPへの強制リダイレクトを有効にするかどうかを指定します。 有効な値: onとoff。

    forward_scheme: アダプティブback-to-originを設定します。

    enable: アダプティブback-to-originを有効にするかどうかを指定します。 有効な値: onとoff。

    scheme_origin: オリジンのプロトコルを指定します。 有効な値: http、https、およびfollow。

    scheme_origin_port: オリジンのポート番号を指定します。 有効な値: 80、443、および80:443。

    green_manager: ポルノ検出を設定します。

    enable: ポルノ検出を有効にするかどうかを指定します。 有効な値: onとoff。

    tmd_signature: カスタムレート制限ルールを指定します。

    name: ルールの名前。グローバルに一意である必要があります。

    path: URI (uniform resource identifier) 。 重複するURIを指定できます。 ただし、それらの有効性を確認する必要があります。

    pathType: 一致するルール。 有効な値: 0と1。 0の値は、プレフィックスの一致を示します。 値1は完全一致を示します。

    interval: データが監視される間隔。 (単位：秒) 間隔は10秒以上でなければなりません。

    count: IPアドレスからの訪問数。

    action: 指定された条件が満たされた後に実行される操作。 有効な値: 0と1。 値0は、アクセスがブロックされていることを示します。 値1は、ボット検出が実行されることを示す。

    ttl: アクセスがブロックされている期間。 (単位：秒)

    l2_oss_key: L2ノードからプライベートOSSバケットへのback-to-originリクエストの秘密鍵認証を設定します。

    private_oss_auth: プライベートOSSバケットへのアクセスを認証するかどうかを指定します。 有効な値: onとoff。

    range: オブジェクトのチャンクを設定します。

    enable: この機能を有効にするかどうかを指定します。 有効な値: onとoff。

    video_seek: ビデオシークを設定します。

    enable: この機能を有効にするかどうかを指定します。 有効な値: onとoff。

    gzip: Gzip圧縮を設定します。

    enable: この機能を有効にするかどうかを指定します。 有効な値: onとoff。

    tesla: ページの最適化を設定してアクセスを高速化します。

    enable: この機能を有効にするかどうかを指定します。 有効な値: onとoff。

    ali_ua: User-Agentベースのアクセス制御を設定します。

    ua: ユーザーエージェント。

    type: リストのタイプ。 有効な値: blackとwhite

    host_redirect: URLの書き換えを設定します。

    regex: 書き換えられるURL。 例: ^/$.

    replacement: 最終URL。 例: /go/act/sale/tbzlsy.php。

    flag: アクション。 有効な値: redirect and break。

    ipv6: IPv6パラメーターを設定します。

    switch: 必須です。 IPv6を有効にするかどうかを指定します。 有効な値: onとoff。 この機能を有効にした後にこの機能を無効にする場合は、設定を削除しないでください。 それ以外の場合、機能は引き続き有効になります。

    region: IPv6が有効になっているリージョン。

    ali_location: リージョンベースのアクセス制御を設定します。

    location: リージョン。

    type: リストのタイプ。 有効な値: blackとwhite

    cc_defense: HTTPフラッド攻撃に対する保護を設定します。

    enable: HTTPフラッド攻撃に対する保護を有効にするかどうかを指定します。 有効な値: onとoff。

    alilive: ApsaraVideo Liveサービスを設定します。

    notify_url: ApsaraVideo Liveから通知を受信するためのURL。

    enable: この機能を有効にするかどうかを指定します。 有効な値: onとoff。

    live_forbid_flv: FLVビデオの再生を禁止するかどうかを指定します。 有効な値: onとoff。

    live_forbid_rtmp: Real-Time Messaging Protocol (RTMP) ビデオの再生を禁止するかどうかを指定します。 有効な値: onとoff。

    live_forbid_hls: HTTPライブストリーミング (HLS) ビデオの再生を禁止するかどうかを指定します。 有効な値: onとoff。

    ali_grtn: grtn (Global Realtime Transport Network) に接続するかどうかを指定します。

    grtn_rts_pub: 取り込みドメインのリアルタイムストリーミング (RTS) ストリーム取り込みを有効にするかどうかを指定します。 有効な値: onとoff。

    grtn_rts_play: ストリーミングドメインのRTSストリーミングを有効にするかどうかを指定します。 有効な値: onとoff。

    edge_function: EdgeScriptを設定します。

    必要なパラメーター:

    rule: ドメイン固有言語 (DSL) スクリプト。

    pri: スクリプトの優先順位。

    enable: スクリプトを有効にするかどうかを指定します。 有効な値: onとoff。

    オプションパラメータ:

    name: スクリプトの名前。

    pos: スクリプトを実行する位置。

    brk: 現在のスクリプトが一致すると、指定された位置以降のスクリプトはスキップされます。

    option: レスポンスヘッダーのデバッグに使用される拡張子。

    grammar: スクリプト言語を指定するために使用される拡張子。 有効な値: es2とjs。 このパラメーターを指定しないままにすることもできます。

    jsmode: JavaScriptでドメイン名ホワイトリストを管理するために使用される拡張子。 有効な値: redirectおよびbypass。

    https_tls_version: トランスポート層セキュリティ (TLS) プロトコルのバージョンを指定します。

    tls10: TLS 1.0を有効にするかどうかを指定します。 デフォルト値: on。 有効な値: onとoff。

    tls11: TLS 1.1を有効にするかどうかを指定します。 デフォルト値: on。 有効な値: onとoff。

    tls12: TLS 1.2を有効にするかどうかを指定します。 デフォルト値: on。 有効な値: onとoff。

    tls13: TLS 1.3を有効にするかどうかを指定します。 デフォルト値: on。 有効な値: onとoff。

    レスポンスパラメーター

    パラメーターデータ型例説明
    RequestIdString04F0F334-1335-436C-A1D7-6C044FE73368

    リクエストの ID です。

    例

    リクエストの例

    http(s):// live.aliyuncs.com/?Action=BatchSetLiveDomainConfigs
&DomainName s=demo.aliyundoc.com、example.aliyundoc.com、example.com
&Functions= [{"functionArgs":[{"argName":"file_type" 、"argValue":"jpg" },{ "argName":"ttl" 、"argValue":"18" },{ "argName":"重量" 、"argValue":"30"}] 、"functionName":"filetype_based_ttl_set" 、"configId":506 * * *}]
&<共通リクエストパラメーター>

    正常に処理された場合のレスポンス例

    XML 形式

    <BatchSetLiveDomainConfigsResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</BatchSetLiveDomainConfigsResponse>

    JSON 形式

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

    エラーコード

    エラーコードリストについては、「API エラーセンター」をご参照ください。

    エラーコード

    説明

    HTTP ステータスコード

    説明

    InvalidFunctions. 不正

    指定された関数が不正です。

    400

    Functionsパラメーターが無効な場合に返されるエラーメッセージ。

    InvalidFunctionName.ValueNotSupported

    unctionName % sはサポートされていません。

    400

    % s機能名が無効な場合に返されるエラーメッセージ。

    InvalidArgName.ValueNotSupported

    ArgName % sはサポートされていません。

    400

    % sパラメーターが無効な場合に返されるエラーメッセージ。

    InvalidArgValue.Malformed

    指定されたArgValueは不正です。

    400

    指定されたパラメーター値が無効な場合に返されるエラーメッセージ。