すべてのプロダクト
Search

このプロダクト

    :DescribeLiveDomainConfigs

    ドキュメントセンター

    :DescribeLiveDomainConfigs

    最終更新日:Dec 17, 2025

    ドメイン名の 1 つ以上の設定を照会します。

    操作説明

    この操作を呼び出して、一度に複数の設定を照会できます。

    QPS 制限

    アカウントごとに、この操作は 1 秒あたり最大 100 回呼び出すことができます。この制限を超えたリクエストは破棄され、サービスが中断されます。この操作を呼び出す際には、この制限に注意することを推奨します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DomainName

    string

    必須

    アップストリーミングドメインまたはストリーミングドメイン。

    demo.aliyundoc.com
    FunctionNames

    string

    必須

    機能の名前。複数の機能をコンマ (,) で区切ります。詳細については、このトピックの「Functions パラメーターで指定される機能」セクションをご参照ください。

    set_req_host_header,set_hashkey_args

    Functions パラメーターで指定される機能

    注：すべてのパラメーター値は文字列型です。filetype_based_ttl_set などの一部の機能は、複数の設定レコードをサポートします。設定レコードの 1 つを更新するには、configId フィールドを使用してレコードを指定します。

    名前パラメーター
    referer_white_list_set：Referer ホワイトリスト。refer_domain_allow_list：ホワイトリストに追加する Referer。複数の Referer をコンマ (,) で区切ります。allow_empty：空の Referer を許可するかどうかを指定します。有効値：on および off。
    referer_black_list_set：Referer ブラックリスト。refer_domain_deny_list：ブラックリストに追加する Referer。複数の Referer をコンマ (,) で区切ります。allow_empty：空の Referer を許可するかどうかを指定します。有効値：on および off。
    filetype_based_ttl_set：ファイルの有効期限が切れるまでの期間。ttl：キャッシュ期間。単位：秒。file_type：ファイルタイプ。複数のファイルタイプをコンマ (,) で区切ります。weight：ファイルタイプの重み。有効値：1～99。
    path_based_ttl_set：ディレクトリの有効期限が切れるまでの期間。ttl：キャッシュ期間。単位：秒。path：ディレクトリ。先頭にスラッシュ (/) を付ける必要があります。weight：ディレクトリの重み。有効値：1～99。
    oss_auth：Object Storage Service (OSS) バケットへのアクセスを認証します。oss_bucket_id：OSS バケットの名前。
    ip_black_list_set：IP アドレスブラックリスト。ip_list：ブラックリストに追加する IP アドレス。複数の IP アドレスをコンマ (,) で区切ります。
    ip_allow_list_set：IP アドレスホワイトリスト。ip_list：ホワイトリストに追加する IP アドレス。複数の IP アドレスをコンマ (,) で区切ります。
    ip_white_list_set：レート制限用の IP アドレスホワイトリスト。ip_list：ホワイトリストに追加する IP アドレス。複数の IP アドレスをコンマ (,) で区切ります。
    error_page：エラーページを指定されたページにリダイレクトします。error_code：エラーコード。rewrite_page：エラーページのリダイレクト先ページ。
    set_req_host_header：back-to-origin リクエストの Host ヘッダーを変更します。domain_name：back-to-origin リクエストの Host ヘッダー。
    set_hashkey_args：指定された URL パラメーターを無視します。hashkey_args：予約するパラメーター。複数のパラメーターをコンマ (,) で区切ります。disable：すべてのパラメーターを無視するかどうかを指定します。有効値：on および off。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：認証用のカスタムバッファー時間。単位：秒。値を 60 秒以上に設定することを推奨します。
    remote_auth：ライブストリーミングのリモート認証を設定します。enable：リモート認証を有効にするかどうかを指定します。この属性は必須です。有効値：on および off。remote_auth_path：認証サーバーのアドレス。この属性は必須です。remote_auth_pattern：認証モード。次のフィールドが利用可能です：- param：アップストリーミング URL のパラメーターを認証サーバーに渡すかどうかを指定します。有効値：pass (デフォルト) および fail。- args_white：渡したいパラメーター。複数のパラメーターをコンマ (,) で区切ります。- args_black：渡したくないパラメーター。複数のパラメーターをコンマ (,) で区切ります。- code：HTTP ステータスコード。認証が成功すると、認証サーバーから ApsaraVideo Live に code=XXX の形式で値が返されます。例：code=200。認証が失敗すると、認証サーバーから ApsaraVideo Live に code=~XXX の形式で値が返されます。例：code=~403。- delta：認証のタイムアウト期間。- retry：認証タイムアウト時のリトライ回数。- timeout：認証タイムアウト時に実行するアクション。有効値：pass および fail。pass：ApsaraVideo Live はリクエストを渡します。fail：ApsaraVideo Live は失敗を示す HTTP ステータスコード 403 を返します。- async：非同期認証を有効にするかどうかを指定します。有効値：on および off (デフォルト)。
    set_resp_header：レスポンスヘッダーを設定します。設定を検証するには、ブラウザでレスポンスメッセージを確認できます。key：レスポンスヘッダーの名前。value：レスポンスヘッダーのコンテンツ。ヘッダーを削除する場合は、null と入力します。
    https_force：HTTPS への強制リダイレクトを設定します。enable：この機能を有効にするかどうかを指定します。有効値：on および off。https_force 機能と http_force 機能は相互排他的です。両方を設定することはできません。いずれかの機能が設定されている場合、もう一方の機能を追加する前に、設定済みの機能を削除する必要があります。
    http_force：HTTP への強制リダイレクトを設定します。enable：この機能を有効にするかどうかを指定します。有効値：on および off。https_force 機能と http_force 機能は相互排他的です。両方を設定することはできません。いずれかの機能が設定されている場合、もう一方の機能を追加する前に、設定済みの機能を削除する必要があります。
    l2_oss_key：L2 ノードからプライベート OSS バケットへの back-to-origin リクエストに対する秘密鍵認証を設定します。private_oss_auth：プライベート OSS バケットへのアクセスを認証するかどうかを指定します。有効値：on および off。
    green_manager：ポルノ検出を設定します。enable：ポルノ検出を有効にするかどうかを指定します。有効値：on および off。
    tmd_signature：カスタムレート制限ルールを設定します。name：ルールの名前。グローバルで一意である必要があります。path：Uniform Resource Identifier (URI)。重複した URI を指定できますが、その有効性を検証する必要があります。pathType：マッチングルール。有効値：0 および 1。0 はプレフィックスマッチを指定します。1 は完全一致を指定します。interval：データが監視される間隔。単位：秒。間隔は 10 秒以上である必要があります。count：IP アドレスからのアクセス回数。action：指定された条件が満たされた後に実行するアクション。有効値：0 および 1。0 はアクセスをブロックすることを指定します。1 はボット検出を実行することを指定します。ttl：アクセスがブロックされる期間。単位：秒。
    forward_scheme：アダプティブ back-to-origin を設定します。enable：この機能を有効にするかどうかを指定します。有効値：on および off。scheme_origin：オリジンのプロトコル。有効値：http、https、および follow。scheme_origin_port：オリジンのポート番号。有効値：80、443、および 80:443。
    video_seek：シーク再生を設定します。enable：シーク再生を有効にするかどうかを指定します。有効値：on および off。
    gzip：Gzip 圧縮を設定します。enable：Gzip 圧縮を有効にするかどうかを指定します。有効値：on および off。
    tesla：ページ最適化を設定してアクセスを高速化します。enable：この機能を有効にするかどうかを指定します。有効値：on および off。
    ali_ua：User-Agent ベースのアクセス制御を設定します。ua：User-Agent の type。有効値：black および white。
    host_redirect：URL 書き換えを設定します。regex：書き換えられる URL。例：^/$.replacement：最終的な URL。例：/go/act/sale/tbzlsy.php。flag：フラグ。有効値：redirect および break。
    ipv6 ：IPv6 を設定します。switch：IPv6 を有効にするかどうかを指定します。この属性は必須です。有効値：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。
    enable：この機能を有効にするかどうかを指定します。有効値：on および off。
    live_forbid_flv：Flash Video (FLV) の再生を禁止するかどうかを指定します。有効値：on および off。
    live_forbid_rtmp：Real-Time Messaging Protocol (RTMP) ビデオの再生を禁止するかどうかを指定します。有効値：on および off。
    live_forbid_hls：HTTP Live Streaming (HLS) ビデオの再生を禁止するかどうかを指定します。有効値：on および off。
    https_option：HTTP 設定を行います。http2：HTTP/2 を有効にするかどうかを指定します。デフォルト値：off。有効値：on および off。live_http2：live_http2 を有効にするかどうかを指定します。デフォルト値：off。有効値：on および off。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED
    DomainConfigs

    object

    DomainConfig

    array<object>

    ドメイン名の設定。

    array<object>

    Status

    string

    設定ステータス。有効値：

    • success

    • testing

    • failed

    • configuring

    success
    ConfigId

    string

    設定 ID。

    5003576
    FunctionName

    string

    機能の名前。

    set_req_host_header
    FunctionArgs

    object

    FunctionArg

    array<object>

    機能の属性。

    object

    ArgName

    string

    属性の名前。

    domain_name
    ArgValue

    string

    属性値。

    developer.aliyundoc.com

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ConfigId": "5003576",
        "FunctionName": "set_req_host_header",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "domain_name",
              "ArgValue": "developer.aliyundoc.com"
            }
          ]
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Invalid%s.ValueNotSupported FunctionName [%s] is not supported.
    404 InvalidUser The user's account is invalid.

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

    変更履歴

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