全部產品
Search

搜尋本產品

    ApsaraVideo Live：BatchSetLiveDomainConfigs

    文件中心

    ApsaraVideo Live：BatchSetLiveDomainConfigs

    更新時間：Jul 23, 2026

    批次設定網域。

    介面說明

    先取得需要進行設定的直播網域，再呼叫本介面批次設定網域。

    QPS 限制

    本介面的單一使用者 QPS 限制為每秒 30 次。超過限制時，API 呼叫會被限流，這可能會影響您的業務，請合理呼叫。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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）可以設定多筆記錄，當需要更新其中某筆記錄時，可透過該筆記錄的 configId 來指定。更多資訊，請參閱下表 Functions 格式說明和Functions 功能說明。

    [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]

    Functions 格式說明

    • 範例如下所示： [{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}]

    • 某些功能（如 filetype_based_ttl_set）可以設定多筆記錄，當需要更新其中某筆記錄時，可透過該筆記錄的 configId 來指定，範例如下所示： [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]

    Functions 功能說明

    名稱參數
    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 鑑權 Bucket。oss_bucket_id：使用者 Bucket 位址。
    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：修改回源 Host 標頭。domain_name：回源 Host 標頭內容。
    set_hashkey_args：忽略 URL 參數。hashkey_args：保留參數的清單。多個項目請以英文逗號（,）分隔。
    disable：是否忽略所有參數。取值：僅支援 on（忽略所有參數）或 off（不忽略）。

    aliauth：阿里鑑權。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 表示鑑權伺服器在鑑權成功時傳回給直播的 HTTP 狀態碼。例如：code=200。code=~XXX 表示鑑權伺服器在鑑權失敗時傳回給直播的 HTTP 狀態碼。例如：code=~403。
    - delta：鑑權逾時時長。
    - retry：鑑權逾時重試次數。
    - timeout：鑑權逾時行為，取值：pass 或 fail。pass：影片直播將直接通過使用者請求。fail：影片直播將回應鑑權失敗狀態碼（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:rewrite 功能。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：影片直播設定。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：option 管控。
    grammar：grammar 管控。可選值：空、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：是否開啟 http2，預設為 off。取值：on 或 off。
    live_http2：是否開啟 live_http2，預設為 off。取值：on 或 off。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    04F0F334-1335-436C-A1D7-6C044FE73368

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    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. 預發環境存在已生效設定，無法修改生產環境設定。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。