批量配置域名。
接口說(shuō)明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| live:BatchSetLiveDomainConfigs | update | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainNames | string | 是 | 需要進(jìn)行批量配置的域名。取值可以是推流域名、主播流域名或子播流域名。多個(gè)域名用英文逗號(hào)（,）分隔。 | demo.aliyundoc.com,example.aliyundoc.com,example.com |
| Functions | string | 是 | 功能列表。 某些功能，如 | [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}] |
Functions 格式說(shuō)明
-
示例如下所示：
[{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}] -
某些功能，如 filetype_based_ttl_set，可以設(shè)置多條記錄，當(dāng)需要更新其中某條記錄時(shí)，可通過(guò)該條記錄的 configId 來(lái)指定，示例如下所示：
[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]
Functions 功能說(shuō)明
| 名稱 | 參數(shù) |
|---|---|
| referer_white_list_set：refer 白名單。 | refer_domain_allow_list：白名單列表，多個(gè)使用英文逗號(hào)（,）分隔。 allow_empty：是否允許空 refer 進(jìn)入。取值：on 或 off。 |
| referer_black_list_set：refer 黑名單。 | refer_domain_deny_list：黑名單列表，多個(gè)使用英文逗號(hào)（,）分隔。 allow_empty：是否允許空 refer 進(jìn)入。取值：on 或 off。 |
| filetype_based_ttl_set：文件過(guò)期時(shí)間設(shè)置。 | ttl：cache 時(shí)間。單位：秒，取值范圍是 1~99999999（3 年多一些）。 file_type：文件類型。多個(gè)使用英文逗號(hào)（,）隔開(kāi)。 weight：權(quán)重。取值范圍：1~99。 |
| path_based_ttl_set：目錄過(guò)期時(shí)間設(shè)置。 | ttl：cache 時(shí)間。單位：秒，取值范圍是 1~99999999（3 年多一些）。 path：目錄。必須以正斜線（/）開(kāi)頭。 weight：權(quán)重。取值范圍：1~99。 |
| oss_auth：OSS 鑒權(quán) Bucket。 | oss_bucket_id：用戶 bucket 地址。 |
| ip_black_list_set：IP 黑名單。 | ip_list：IP 列表。多個(gè)使用英文逗號(hào)（,）隔開(kāi)。 |
| ip_allow_list_set：IP 白名單。 | ip_list：IP 列表。多個(gè)使用英文逗號(hào)（,）隔開(kāi)。 |
| ip_white_list_set：訪問(wèn)頻次控制免攔截。 | ip_list：IP 列表。多個(gè)使用英文逗號(hào)（,）隔開(kāi)。 |
| error_page：錯(cuò)誤頁(yè)面重定向。 | error_code：錯(cuò)誤碼。 rewrite_page：重定向頁(yè)面。 |
| set_req_host_header：修改回源 Host 頭。 | domain_name：回源 Host 頭內(nèi)容。 |
| set_hashkey_args：忽略 URL 參數(shù)。 | hashkey_args：保留參數(shù)的列表。多個(gè)使用英文逗號(hào)（,）分隔。 disable：是否忽略所有參數(shù)。取值：僅支持 on（忽略所有參數(shù)）或 off（不忽略）。 |
| aliauth：阿里鑒權(quán)。 | auth_type：鑒權(quán)類型。取值：type_a（鑒權(quán) A）、no_auth（關(guān)閉鑒權(quán)）。 auth_key1：鑒權(quán) key1，鑒權(quán) key 支持大寫字母、小寫字母、數(shù)字，建議設(shè)置長(zhǎng)度為 8~32 個(gè)字符。 auth_key2：鑒權(quán) key2。 ali_auth_delta：自定義鑒權(quán)緩沖時(shí)間，單位：分鐘。建議最小設(shè)置為 1 分鐘，無(wú)上限限制。 auth_m3u8：是否開(kāi)啟 m3u8 內(nèi)容改寫，對(duì) m3u8 里面的 ts 補(bǔ)齊對(duì)應(yīng)的鑒權(quán)，可以避免 ts 的訪問(wèn)鑒權(quán)失敗。取值：on（默認(rèn)值）或 off。 |
| remote_auth：直播遠(yuǎn)程鑒權(quán) 。 | enable：是否開(kāi)啟遠(yuǎn)程鑒權(quán)，必填項(xiàng)。取值：on 或 off。 remote_auth_path ： 鑒權(quán)服務(wù)器地址，必填項(xiàng)。 remote_auth_pattern ：鑒權(quán)模式串。有以下功能可設(shè)置： - param：是否向鑒權(quán)服務(wù)器透?jìng)魍屏?URL 中的參數(shù)，取值 pass（默認(rèn)）或 fail。 - args_white：透?jìng)髦付▍?shù)設(shè)置，多個(gè)參數(shù)用英文逗號(hào)（,）分隔。 - args_black：不透?jìng)髦付▍?shù)設(shè)置，多個(gè)參數(shù)用英文逗號(hào)（,）分隔。 - code：鑒權(quán)狀態(tài)碼，code=XXX，鑒權(quán)服務(wù)器在鑒權(quán)成功時(shí)返回給直播的 HTTP 狀態(tài)碼。例如：code=200。code=~XXX，鑒權(quán)服務(wù)器在鑒權(quán)失敗時(shí)返回給直播的 HTTP 狀態(tài)碼。例如：code=~403。 - delta ：鑒權(quán)超時(shí)時(shí)長(zhǎng)。 - retry：鑒權(quán)超時(shí)重試次數(shù)。 - timeout：鑒權(quán)超時(shí)行為，取值：pass 或 fail。pass：視頻直播將直接通過(guò)用戶請(qǐng)求。fail：視頻直播將響應(yīng)鑒權(quán)失敗狀態(tài)碼（403）給用戶。 - async：異步鑒權(quán)，取值 on（開(kāi)啟異步鑒權(quán)）或 off（默認(rèn)，關(guān)閉異步鑒權(quán)）。 |
| set_resp_header：設(shè)置響應(yīng)頭（瀏覽器端可見(jiàn)）。 | key：響應(yīng)頭。取值： 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：響應(yīng)頭內(nèi)容。刪除填寫 null。 |
| https_force：強(qiáng)制 HTTPS 跳轉(zhuǎn)。 | enable：功能開(kāi)關(guān)。取值：on 或 off。https_force 和 http_force 只能存在其中一個(gè)，兩者為互斥關(guān)系，配置另外一個(gè)需要先刪除原來(lái)的配置。 |
| http_force：強(qiáng)制 HTTP 跳轉(zhuǎn)。 | enable：功能開(kāi)關(guān)。取值：on 或 off。https_force 和 http_force 只能存在其中一個(gè)，兩者為互斥關(guān)系，配置另外一個(gè)需要先刪除原來(lái)的配置。 |
| forward_scheme：自適應(yīng)回源。 | enable：功能開(kāi)關(guān)，取值：on 或 off。 scheme_origin：回源站協(xié)議 （http、https、follow）。 scheme_origin_port：回源站協(xié)議端口（80、443、80:443）。 |
| green_manager：鑒黃功能。 | enable：是否開(kāi)啟鑒黃功能。取值：on 或 off。 |
| tmd_signature：自定義的訪問(wèn)頻次控制規(guī)則。 | name：規(guī)則名稱。域名內(nèi)不可重復(fù)。 path：可重復(fù)，需校驗(yàn) URI 路徑合法性。 pathType：匹配規(guī)則。0 前綴匹配，1 完全匹配。 interval：監(jiān)測(cè)時(shí)長(zhǎng)。單位：秒。參數(shù)限制必須≥10。 count：?jiǎn)?IP 訪問(wèn)次數(shù)。 action：阻斷類型。0 封禁，1 人機(jī)識(shí)別。 ttl：阻斷時(shí)長(zhǎng)。單位：秒。 |
| l2_oss_key：L2 OSS 回源私鑰。 | private_oss_auth：是否開(kāi)啟私有 OSS 鑒權(quán)功能。取值：on 或 off。 |
| video_seek：視頻切片拖拽開(kāi)關(guān)。 | enable：功能開(kāi)關(guān)。取值：on 或 off。 |
| gzip：頁(yè)面 Gzip 優(yōu)化 。 | enable：功能開(kāi)關(guān)。取值：on 或 off。 |
| tesla：頁(yè)面優(yōu)化加速。 | enable：功能開(kāi)關(guān)。取值：on 或 off。 |
| ali_ua：User-Agent 限制訪問(wèn)。 | ua：User-Agent。 type：名單類型。取值 black 和 white。 |
| host_redirect:rewrite功能。 | regex：需要重寫的 URL。例如 ^/$。 replacement：目標(biāo) URL。例如 /go/act/sale/tbzlsy.php。 flag：僅支持：redirect、break。 |
| ipv6：ipv6 配置。 | switch：開(kāi)關(guān)（必填）。取值：on 或 off，開(kāi)啟功能，一旦開(kāi)啟后，如需關(guān)閉請(qǐng)取消勾選，不要?jiǎng)h除配置，否則不生效。 region：開(kāi)啟 IPv6 功能的地域，取值：cn-beijing（北京）、cn-shanghai（上海）、cn-shenzhen（深圳）、cn-qingdao（青島）、apsoutheast-1（新加坡）、eu-central-1（德國(guó)）、ap-northeast-1（東京）、ap-southeast-5（雅加達(dá)）。 |
| ali_location：區(qū)域限制訪問(wèn)。 | location：地域列表。 type：名單類型。取值 black 或 white。 |
| cc_defense：防 CC 攻擊。 | enable：開(kāi)啟或關(guān)閉防 CC 攻擊。取值：on 或 off。 |
| alilive：視頻直播配置。 | notify_url：直播通知 URL。 enable：功能開(kāi)關(guān)。取值：on 或 off。 live_forbid_flv：禁止播放 flv。取值：on 或 off。 live_forbid_rtmp：禁止播放 rtmp。取值：on 或 off。 live_forbid_hls：禁止播放 hls。取值：on 或 off。 |
| ali_grtn：grtn 業(yè)務(wù)接入開(kāi)關(guān)。 | grtn_rts_pub：RTS 推流開(kāi)關(guān)，推流域名使用。取值：on 或 off。 grtn_rts_play：RTS 播流開(kāi)關(guān)，播流域名使用。取值：on 或 off。 grtn_rts_transcode：RTS H5 播放自動(dòng)轉(zhuǎn)碼開(kāi)關(guān)。取值：on 或 off。 |
| edge_function：邊緣函數(shù)。 | 必填參數(shù)： rule：DSL 規(guī)則。 pri：優(yōu)先級(jí)。 enable：本條規(guī)則是否生效。取值：on 或 off。 可選參數(shù)： name：規(guī)則名稱。 pos：規(guī)則執(zhí)行位置。 brk：命中本條規(guī)則后，當(dāng)前執(zhí)行位置剩余規(guī)則均跳過(guò)。 option：option 管控。 grammar：grammar 管控。可選值：空、es2、js。 jsmode：js 域名白單管控，可選值：redirect 或 bypass。 |
| https_tls_version：TLS 協(xié)議版本。 | tls10：開(kāi)啟 TLSv1.0，默認(rèn)為 on。取值：on 或 off。 tls11：開(kāi)啟 TLSv1.1，默認(rèn)為 on。取值：on 或 off。 tls12：開(kāi)啟 TLSv1.2，默認(rèn)為 on。取值：on 或 off。 tls13：開(kāi)啟 TLSv1.3，默認(rèn)為 on。取值：on 或 off。 |
| https_option：http 協(xié)議設(shè)置。 | http2：是否開(kāi)啟 http2，默認(rèn)為 off。取值：on 或 off。 live_http2：是否開(kāi)啟 live_http2，默認(rèn)為 off。取值：on 或 off。 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 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.ValueNotSupported | ArgName [%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. | 預(yù)發(fā)環(huán)境存在已生效配置，無(wú)法修改生產(chǎn)環(huán)境配置。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-09-29 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 錯(cuò)誤代碼 | 描述 | HTTP 狀態(tài)碼 | 語(yǔ)義 |
|---|---|---|---|
| InvalidFunctions.Malformed | Specified Functions is malformed. | 400 | 指定的 Functions 不合法。 |
| InvalidFunctionName.ValueNotSupported | unctionName %s is not supported. | 400 | 不支持的 FunctionName %s（%s 為具體功能名）。 |
| InvalidArgName.ValueNotSupported | ArgName %s is not supported. | 400 | 不支持的 ArgName %s（%s 為具體參數(shù)名）。 |
| InvalidArgValue.Malformed | Specified ArgValue is malformed. | 400 | 指定的 ArgValue 不合法。 |