增量修改域名信息
更新時間 2025-08-06 10:47:10
最近更新時間: 2025-08-06 10:47:10
分享文章
接口描述:調用本接口增量修改加速域名配置信息
請求方式:post
請求路徑:/domain/update-domain
使用說明:
- 修改域名之前,您需要先開通對應產品類型的服務,且保證資源包/按需服務有效;
- 該域名沒有在途工單;
- 單個用戶一分鐘限制調用10次。
請求參數說明:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| domain | string | 是 | 域名 | |
| product_code | string | 是 | 產品類型 | “001”(靜態加速),“003”:(下載加速), “004”(視頻點播加速),“008”(CDN加速),“006”(全站加速),“007”(安全加速) |
| ipv6_enable | int | 否 | ipv6啟用 | 未傳代表不修改,1(啟用); 2(關閉) |
| origin | list<origin_single> | 否 | 回源信息 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段origin_single詳細說明見下方 |
| xos_origin_is | int | 否 | 是否開啟媒體存儲源站配置功能 | 0(關閉), 1(開啟);默認0 |
| xos_origin | object | 否 | 媒體存儲源站信息 | 未傳代表不修改,有傳代表整個數組全量修改,字段xos_origin詳細說明見下方 |
| req_host | string | 否 | 回源host設置 | 傳空字符串""代表刪除,未傳代表不修改 |
| origin_host_type | int | 否 | 主備源攜帶不同的回源host是否開啟 | 未傳代表不修改,0(關閉) ;1(開啟)。主備源攜帶不同的回源host開啟(origin_host_type等于1):同時配置origin帶不同的回源host和回源host,且都有傳具體值,則以origin帶不同的回源host生效(清空回源host)。 |
| origin_host_http | dict | 否 | http類型origin帶不同的回源host | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改 |
| backup_origin_timeout | string | 否 | 回源連接超時時間,單位秒 | |
| backup_origin_resptimeout | string | 否 | 回源響應超時時間,單位秒 | |
| black_referer | dict | 否 | referer黑名單 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,字段black_referer詳細說明見下方 |
| black_referer_condition | dict | 否 | referer黑名單condition | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,刪除black_referer數據的話condition也要刪除,格式:{“black_referer”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]},mode取值:默認0, 0:文件后綴 1:目錄 2: 首頁 3: 全部文件 4: 全路徑。本參數僅適用于類型為新框架的域名,舊框架域名修改不生效,當前只支持配置單條全量修改,字段black_referer詳細說明見下方,黑白名單只允許存在一個,若同時存在只處理黑名單 |
| white_referer | dict | 否 | referer白名單 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,字段white_referer詳細說明見下方 |
| white_referer_condition | dict | 否 | referer白名單condition | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,刪除white_referer數據的話condition也要刪除,格式:{“white_referer”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]},mode取值:默認0, 0:文件后綴 1:目錄 2: 首頁 3: 全部文件 4: 全路徑。本參數僅適用于類型為新框架的域名,舊框架域名修改不生效,當前只支持配置單條 |
| user_agent | dict | 否 | user_agent黑白名單配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,字段user_agent詳細說明見下方 |
| filetype_ttl | list<filetype_ttl_single> | 否 | 緩存類型設置 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段filetype_ttl_single詳細說明見下方 |
| ip_black_list | string | 否 | ip黑名單 | 傳空字符串""代表刪除,未傳代表不修改,黑白名單只允許存在一個,若同時存在只處理黑名單,支持ip段與ip,多個ip/ip段以逗號分割,示例:1.1.1.1,2.2.2.2,::1,3.3.3.3-4.4.4.4 |
| ip_white_list | string | 否 | ip白名單 | 傳空字符串""代表刪除,未傳代表不修改,黑白名單只允許存在一個,若同時存在只處理白名單,支持ip段與ip,多個ip/ip段以逗號分割,示例:1.1.1.1,2.2.2.2,::1,3.3.3.3-4.4.4.4 |
| req_headers | list<req_headers_single> | 否 | 自定義回源請求頭 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段req_headers_single詳細說明見下方 |
| resp_headers | list<resp_headers_single> | 否 | 自定義響應請求頭 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段resp_headers_single詳細說明見下方 |
| error_code | list<error_code_single> | 否 | 錯誤狀態碼緩存 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段error_code_single詳細說明見下方 |
| shared_host | string | 否 | 共享緩存域名 | 傳空字符串""代表刪除,未傳代表不修改 |
| https_status | string | 否 | https是否開啟 | 未傳代表不修改,取值:on、off,取值為on時,cert_name為必傳字段 |
| cert_name | string | 否 | 國際證書備注名 | 未傳代表不修改,傳空字符串代表刪除 |
| cert_name_gm | string | 否 | 國密證書備注名 | 未傳代表不修改,傳空字符串代表刪除 |
| https_basic | dict | 否 | https基礎信息 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,字段https_basic詳細說明見下方 |
| basic_conf | dict | 否 | http配置基礎信息 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,字段basic_conf詳細說明見下方 |
| limit_speed_uri | list<limit_speed_uri_single> | 否 | 基于url參數限速 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段limit_speed_uri_single詳細說明見下方 |
| limit_speed_uri_condition | dict | 否 | limit_speed_uri的condition配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,格式:{“{key}”:[{“mode”:類型,“content”:“配置內容,多個以逗號間隔”}]},mode類型為int,取值默認0,可以為:0(文件后綴),1(目錄),2(首頁),3(全部文件),4(全路徑),key為limit_speed_uri中的id.使用限制:一個key對應的數組大小只能是1,因為配置平臺實際只支持配置一條;content必填,長度大于0,不能為空字符串或者空白字符串 |
| limit_speed_const | list<limit_speed_const_single> | 否 | 基于固定值限速 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段limit_speed_const_single詳細說明見下方 |
| limit_speed_const_condition | dict | 否 | limit_speed_const的condition配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,格式:{“{key}”:[{“mode”:類型,“content”:“配置內容,多個以逗號間隔”}]},mode類型為int,取值默認0,可以為:0(文件后綴),1(目錄),2(首頁),3(全部文件),4(全路徑),key為limit_speed_const中的id。使用限制:一個key對應的數組大小只能是1,因為配置平臺實際只支持配置一條;content必填,長度大于0,不能為空字符串或者空白字符串 |
| remote_sync_auth | list<remote_sync_auth_single> | 否 | 遠程同步鑒權客戶自助 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段remote_sync_auth_single詳細說明見下方 |
| remote_sync_auth_condition | dict | 否 | 遠程同步鑒權condition | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,格式:{“key”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]}, mode類型為int,取值默認0,可以為:0(文件后綴),1(目錄),2(首頁),3(全部文件),4(全路徑),key為remote_sync_auth中的id |
| ssl | string | 否 | ssl協議類型 | 傳空字符串"“代表刪除,未傳代表不修改,支持TLSv1 、TLSv1.1 、TLSv1.2 、TLSv1.3,默認值為”",支持多選,多個用英文逗號分隔 |
| ssl_stapling | string | 否 | ocsp stapling開關 | 未傳代表不修改,on(開啟),off(關閉) |
| cus_gzip | list<cus_gzip_single> | 否 | 文件壓縮 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段cus_gzip_single詳細說明見下方,原來文件壓縮的字段為gzip字段,現改成cus_gzip,兩參數不能同時傳,若之前用的是gzip字段建議遷移至cus_gzip |
| cus_gzip_condition | dict | 否 | 文件壓縮condition配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,格式:{“key”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]}, mode取值:默認0, 0:文件后綴 1:目錄 2: 首頁 3: 全部文件 4: 全路徑。key為cus_gzip中的id,本參數僅適用于類型為新框架的域名,舊框架域名修改不生效,且修改本參數時,cus_gzip必傳 |
| entry_limits | list<entry_limits_single> | 否 | 限頻自助參數 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段entry_limits_single詳細說明見下方,本參數僅適用于類型為新框架的域名,舊框架域名修改不生效。特別注意,若傳空數組[]刪除entry_limits參數時,若entry_limits_condition有值,也需要entry_limits_condition傳空對象{}刪除。 |
| entry_limits_condition | dict | 否 | 限頻自助參數condition配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,格式:{“key”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]}, mode取值:默認0, 0:文件后綴 1:目錄 2: 首頁 3: 全部文件 4: 全路徑。key為entry_limits中的id,本參數僅適用于類型為新框架的域名,舊框架域名修改不生效 |
| cachekey_args | list<cachekey_args_single> | 否 | 緩存參數 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段cachekey_args_single詳細說明見下方 |
| cachekey_args_condition | dict | 否 | 緩存參數condition配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改,格式:{“key”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]}, mode取值:默認0, 0:文件后綴 1:目錄 2: 首頁 3: 全部文件 4: 全路徑。key為cachekey_args中的id,本參數僅適用于類型為新框架的域名,舊框架域名修改不生效 |
| backorigin_uri_rewrite | list<backorigin_uri_rewrite> | 否 | 回源uri改寫 | 傳空對象[]代表刪除,未傳代表不修改,有傳代表全量修改;字段backorigin_uri_rewrite詳細說明見下方 |
| backorigin_uri_rewrite_condition | dict | 否 | 回源uri改寫condition配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改;格式:{“key”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]}, mode取值:默認0, 0:文件后綴 1:目錄 2: 首頁 3: 全部文件 4: 全路徑。key為backorigin_uri_rewrite中的id,本參數僅適用于類型為新框架的域名,舊框架域名修改不生效 |
| backorigin_arg_rewrite | list<backorigin_arg_rewrite> | 否 | 回源參數改寫 | 傳空對象[]代表刪除,未傳代表不修改,有傳代表全量修改;字段backorigin_arg_rewrite詳細說明見下方 |
| backorigin_arg_rewrite_condition | dict | 否 | 回源參數改寫condition配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改;格式:{“key”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]}, mode取值:默認0, 0:文件后綴 1:目錄 2: 首頁 3: 全部文件 4: 全路徑。key為backorigin_arg_rewrite中的id,本參數僅適用于類型為新框架的域名,舊框架域名修改不生效 |
| ignore_backorigin_args | int | 否 | 是否忽略回源參數 | 0(不忽略),1(忽略);默認0 |
| dns_query | dict | 否 | 回源域名解析 | 字段dns_query詳細說明見下方 |
| error_page | list<error_page_single> | 否 | 錯誤頁面重定向 | 傳空數組[]代表刪除,未傳代表不修改,有傳代表整個數組全量修改,字段error_page_single詳細說明見下方 |
| define_redirect | list<define_redirect> | 否 | 自定義重定向配置 | 傳空對象[]代表刪除,未傳代表不修改,有傳代表全量修改;字段define_redirect詳細說明見下方 |
| define_redirect_condition | dict | 否 | 自定義重定向condition配置 | 傳空對象{}代表刪除,未傳代表不修改,有傳代表整個dict全量修改;格式:{“key”:[{“mode”:類型, “content”:“配置內容,多個以逗號間隔”}]}, mode取值:默認0, 0:文件后綴 1:目錄 2: 首頁 3: 全部文件 4: 全路徑;其中key為define_redirect:id |
1)參數origin_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| origin | string | 是 | 源站ip或域名 | |
| port | int | 否 | 回源地址端口 | 默認80;支持http自定義端口,http不支持下發443端口。多個源站時,源站端口需保持一致;該字段功能由【basic_conf.http_origin_port】字段替代,若兩個字段均傳值需保持一致,且修改以http_origin_port字段為準。 |
| weight | int | 是 | 權重 | 權重,范圍1-100, role和weight都不存在或取值一致時,按輪詢策略,默認10 |
| role | string | 是 | 源站角色 | 取值:master/slave 默認master |
| protocol | string | 否 | 源站類型 | 默認http,目前不支持自定義配置https源站。 |
2)參數xos_origin:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| xos_origin[*].origin | string | 是 | 媒體存儲源站 | |
| xos_origin[*].ak | string | 否 | 媒體存儲源站加密ak | ak與sk必須同時填寫 |
| xos_origin[*].sk | string | 否 | 媒體存儲源站加密sk | ak與sk必須同時填寫 |
3)參數black_referer:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| allow_empty | string | 否 | referer是否允許為空 | 取值"on", “off”,默認“off” |
| allow_list | list< string > | 否 | referer黑名單列表 | 默認[] |
| match_all_ports | string | 否 | referer是否匹配所有端口 | 取值"on", “off”,默認“off” |
| ignore_case | string | 否 | referer是否忽略大小寫 | 取值"on", “off”,默認“off” |
| is_append | int | 否 | 是否追加referer黑名單列表 | 是否在原來的黑名單列表基礎上追加黑名單,取值 1:追加, 0:覆蓋,不傳默認0覆蓋。當傳入的值為1的時候,將當前傳入的allow_list追加到已有配置的黑名單列表。當傳入值0或者不傳值的時候,當前傳入的allow_list覆蓋已有配置的黑名單列表 |
| referer_empty_protocol | string | 否 | referer允許空協議 | 取值"on", “off”,默認“off” |
| except_list | list< string > | 否 | referer例外名單 |
4)參數white_referer:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| allow_empty | string | 否 | referer是否允許為空 | 取值"on", “off”,默認“off” |
| allow_list | list< string > | 否 | referer白名單列表 | 默認[] |
| match_all_ports | string | 否 | referer是否匹配所有端口 | 取值"on", “off”,默認“off” |
| ignore_case | string | 否 | referer是否忽略大小寫 | 取值"on", “off”,默認“off” |
| is_append | int | 否 | 是否追加referer白名單列表 | 是否在原來的白名單列表基礎上追加白名單,取值 1:追加, 0:覆蓋,不傳默認0覆蓋。當傳入的值為1的時候,將當前傳入的allow_list追加到已有配置的白名單列表。當傳入值0或者不傳值的時候,當前傳入的allow_list覆蓋已有配置的白名單列表 |
| referer_empty_protocol | string | 否 | referer允許空協議 | 枚舉值:on、off,默認off |
| except_list | list< string > | 否 | referer例外名單 |
5)參數user_agent:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| type | int | 是 | 類型 | 枚舉值:0(黑名單),1(白名單) |
| ua | list | 是 | user_agent列表,多個用英文,隔開 | |
| mode | int | 否 | 匹配方式 | 枚舉值:0(通配符),1(正則);不傳默認1 |
| ignore_case | string | 否 | 忽略大小寫 | 枚舉值:on(是)、off(否);不傳默認on |
6)參數filetype_ttl_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| cache_type | int | 是 | 緩存類型 | 1(不緩存);2(遵循源站); 3(強制緩存);4(custom緩存)。 |
| cache_with_args | int | 是 | 是否帶參數緩存 | 0(不帶參數緩存);1(帶參數緩存); 默認0。 |
| mode | int | 否 | 模式 | 0(文件后綴);1(目錄); 2(首頁);3(全部文件);4:(全路徑);5( 正則),默認0 |
| file_type | string | 是 | 緩存文件類型,多個以逗號隔開 | 當模式mode為文件后綴時,緩存文件類型例如:jpg,png,css(以",“分割);當模式mode為目錄時,緩存文件類型例如/test,/a/b/c(不能以”/"結尾);當模式mode為首頁時,緩存文件類型固定為/ ;當模式mode為全部文件時,緩存文件類型固定為/ ;當模式mode為全路徑時,緩存文件類型例如/index.html,/test/*.jpg |
| priority | int | 否 | 優先級 | 范圍:1-100,默認10。 |
| ttl | int | 是 | 緩存時間,單位秒 |
7)參數req_headers_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| key | string | 是 | 自定義回源請求頭名稱 | |
| value | string | 否 | 自定義回源請求頭值 | 默認"" |
8)參數resp_headers_single:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| key | string | 是 | 自定義響應頭名稱 | |
| value | string | 否 | 自定義響應頭值 | 默認"" |
| cors_check | string | 否 | 跨域驗證開關 | 枚舉值:on(開啟),off(關閉),默認關閉;當且僅key為Access-Control-Allow-Origin,該字段有效 |
9)參數error_code_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| code | list< int > | 是 | 錯誤狀態碼 | |
| ttl | int | 是 | 緩存時間 | 單位秒 |
10)參數https_basic:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| force_status | string | 否 | 強制跳轉狀態碼 | 默認:302 |
| http_force | string | 否 | http強制跳轉 | 取值:“on”:跳轉 “off”:不跳轉 |
| https_force | string | 否 | https強制跳轉 | 取值:“on”:跳轉 “off”:不跳轉 |
| origin_protocol | string | 是 | https回源協議 | 取值: http:回http協議回源 https:用https協議回源, follow_request:跟隨訪問協議進行回源 |
11)參數basic_conf:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| follow_302 | int | 否 | 是否拉取跳轉后文件 | 0(否);1(是) |
| use_http2 | int | 否 | 是否開啟http2 | 取值:0(不開啟);1(開啟);默認0 |
| http_origin_port | int | 否 | http請求回源端口 | 未傳不修改;不支持443端口 |
| https_origin_port | int | 否 | https請求回源端口 | 未傳不修改;取值范圍:1-65535 |
12)參數limit_speed_uri_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| id | string | 是 | limit_speed_uri列表內唯一 | 可以考慮使用時間戳拼上列表索引,比如時間戳為11657615509083,拼上序列化0,則id為:116576155090830 |
| unit | string | 是 | 單位 | 可選值b/s,Kb/s,Mb/s |
| args | string | 是 | uri參數名 | |
| time_seg | string | 否 | 時段 | 正則表達式,比如:(08:[2-5][0-9] |
| weight | int | 否 | 優先級 | 默認值10,取值范圍[1,) |
13)參數limit_speed_const_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| id | string | 是 | 基于固定值限速唯一標識,limit_speed_const列表內唯一 | 可以考慮使用時間戳拼上列表索引,比如時間戳為11657615509083,拼上序列化0,則id為:116576155090830 |
| rate | int | 是 | 限速值 | 取值范圍[0,) |
| time_seg | string | 否 | 時段 | 正則表達式,比如:(08:[2-5][0-9] |
| unit | string | 是 | 單位 | 可選值b/s(即Byte/s),Kb/s(即KByte/s),Mb/s(即MByte/s) |
| weight | int | 否 | 優先級 | 默認值10,取值范圍[1,) |
14)參數remote_sync_auth_single:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| auth_body_data | string | 否 | 請求體 | 默認為空"",請求方法為POST才生效 |
| auth_connection_idle_time | int | 否 | 連接空閑超時時間 | 連接空閑超時時間 |
| auth_connection_pool_size | int | 否 | 鑒權服務端連接池大小 | 鑒權服務端連接池大小 |
| auth_error_pass | string | 否 | 鑒權出錯是否通過 | 取值:on:是,off:否 |
| auth_host | list< string > | 是 | 鑒權源站 | ip或者域名 |
| auth_method | string | 否 | 請求方法 | 取值為:GET/POST/HEAD/OPTIONS,如選擇POST,顯示“請求體”輸入框 |
| auth_port | int | 否 | 請求端口 | 請求端口,http默認80,https默認443 |
| auth_respond_action | string | 否 | 鑒權狀態碼黑白名單 | 鑒權狀態碼黑白名單,(白名單 “allow” 或 黑名單 “deny”),默認deny |
| auth_respond_status | list< int?> | 否 | 狀態碼 | 可以為空,狀態碼 |
| auth_scheme | string | 否 | 請求協議 | 默認http,值為http/https |
| auth_timeout | float | 否 | 鑒權超時時間 | 鑒權設置,鑒權超時時間,單位秒,支持輸入毫秒,最大值3600秒,小數位數最大3位 |
| auth_timeout_pass | string | 否 | 鑒權超時是否通過 | 鑒權邏輯,鑒權超時是否通過,取值:on:是,off:否 |
| forbidden_code | int | 否 | 固定狀態碼 | 當上面鑒權不通過時狀態碼設置為固定狀態碼的時候必填 |
| forbidden_code_state | string | 否 | 鑒權不通過時狀態碼設置 | 鑒權不通過時狀態碼設置,(跟隨鑒權源站follow/固定狀態碼regular),默認"follow" |
| id | string | 是 | 遠程同步鑒權客戶自助 | 主鍵id,condition使用 |
| pattern | string | 否 | pattern | 鑒權請求uri,默認空 |
| priority | int | 否 | 優先級 | 默認10 |
| replace | string | 否 | replace | 鑒權請求uri,默認空 |
| response_json_to_var | dict | 否 | 基于json鑒權 | 基于json鑒權 |
| response_json_to_var.forbidden_code | int | 否 | 鑒權不通過狀態碼 | 有運維condition,id為RemoteSyncAuth的id+_json_forbidden_code,如xxxxxx_json_forbidden_code,此參數只有有配置condition的時候才生效 |
| response_json_to_var.json_var_list | list< dict > | 否 | json數據 | 成對出現,可添加多對 |
| response_json_to_var.json_var_list[*]arg_name | string | 是 | 變量名 | |
| response_json_to_var.json_var_list[*]arg_value | string | 是 | 變量值 | |
| response_json_to_var.switch | int | 否 | json數據開關 | 0(關),1(開) |
| subject | string | 是 | subject | 鑒權請求uri,默認值$uri |
| try_next_remote_server_when | string | 否 | 鑒權源站重試狀態碼 | 底層默認默認^5.+ |
| use_main_request_args | list< dict > | 否 | 請求參數 | |
| use_main_request_args[*].arg_name | string | 是 | 請求參數key | |
| use_main_request_args[*].arg_value | string | 否 | 請求參數value | 默認空,空代表刪除 |
| use_main_request_args_type | string | 否 | 使用原始請求參數類型 | 當上面是否使用原始請求參數選擇否的時候,必填,取值:繼承并修改原參數inherit/全面替換原參數replace,默認繼承 |
| use_main_request_headers | list< dict > | 否 | 請求頭 | |
| use_main_request_headers[*].arg_name | string | 是 | 請求頭key | |
| use_main_request_headers[*].arg_value | string | 否 | 請求頭value | 默認空,空代表刪除 |
| use_main_request_headers_type | string | 否 | 使用原始請求頭類型 | 當上面是否使用原始請求頭選擇否的時候,必填,取值:繼承并修改原參數inherit/全面替換原參數replace,默認繼承 |
| use_original_request_args | string | 否 | 是否使用原始請求參數 | 鑒權請求參數:是否使用原始請求參數,取值:on /off,沒值不傳,后端默認是 |
| use_original_request_headers | string | 否 | 是否使用原始請求頭 | 鑒權請求頭:是否使用原始請求頭,取值:on /off,沒值不傳,后端默認是 |
15)參數cus_gzip_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| id | string | 是 | id | 跟cus_gzip_condition客戶自助的condition的id是一一對應 |
| min_length | string | 是 | 壓縮文件大小 | 格式:(1-1023)B,(1-1023) K,(1-102399) M,(1-1023)b,(1-1023) k,(1-102399)m |
| file_type | string | 是 | 壓縮文件類型 | 多個用英文逗號分隔 |
| type | int | 否 | 壓縮類型 | 取值:0(gzip),1(brotli),不傳值為0 |
| http_version | string | 否 | http_version | 取值:1.1 ,1.0,不傳值為null |
| vary | string | 否 | gzip_vary | 取值:on(開啟),off(關閉)不傳值為null |
| max_length | string | 否 | 最大文件大小 | 格式:(1-1023)B,(1-1023)K,(1-102399)M,(1-1023)b,(1-1023)k,(1-102399)m,不傳為null |
16)參數entry_limits_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| id | string | 是 | 唯一id | |
| limit_element | string | 是 | 限制參數 | |
| frequency_threshold | int | 是 | 訪問次數限制閾值 | 單位:次數,取值范圍:大于等于0 |
| frequency_time_range | int | 是 | 統計周期 | 單位:s,取值范圍:[0,3600] |
| forbidden_duration | int | 是 | 拒絕訪問時間 | 取值范圍:大于等于0 |
| forbidden_duration_unit | string | 否 | 拒絕訪問時間單位 | 取值范圍:[s,millis],默認s |
| forbidden_code | int | 否 | 封禁http訪問碼 | 取值范圍:大于等于0 |
| white_ip_control | list< string > | 否 | 不執行校驗的客戶端ip | 支持ip和ip段,ipv4,ipv6 |
| priority | int | 是 | 優先級 | 取值范圍:[1,100] |
17)參數cachekey_args_single:
| 參數名 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| id | string | 是 | 基于緩存參數唯一標識 | id不可重復 |
| priority | int | 否 | 優先級 | 默認值10,取值范圍[1,100] |
| ignore | int | 否 | 去參數緩存開關 | 取值:0-否,1-是(即忽略所有參數), 默認值1,取值范圍[0,1] |
| ignore_args | string | 否 | 忽略特定參數緩存 | 去參數緩存開關為1時配置有效;默認值"",若需要忽略多個參數,中間用逗號分割;若ignore=1,ignore_args傳指定參數配置值(如:a,b),表示忽略指定參數 |
| is_with_args | int | 否 | 帶特定參數緩存 | 去參數緩存開關為0時配置有效;取值:0 否,1 是,默認值1,取值范圍[0,1];若ignore=0,is_with_args=0,表示緩存所有參數 |
| mode | string | 否 | 匹配方式 | 帶特定參數緩存為1時配置有效;取值:0 字符串, 1 正則,默認值0,取值范圍[0,1] |
| args | string | 否 | 參數串 | 匹配方式為0時配置有效,默認值"";若ignore=0,is_with_args=1,mode固定傳0,args傳指定參數配置值,表示保留指定參數。其中如果參數含有中劃線-需轉為下劃線_,并聯系客服配置dash_in_args。 |
| subject | string | 否 | subject | 匹配方式為1時配置,默認值"" |
| pattern | string | 否 | pattern | 匹配方式為1時配置,默認值"" |
| replace | string | 否 | replace | 匹配方式為1時配置,默認值"" |
18)參數backorigin_uri_rewrite:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| id | str | 是 | 唯一標識 | id不可重復,可以考慮使用時間戳拼上列表索引 |
| subject | str | 否 | 改寫對象 | 匹配模式+改寫后uri+改寫對象需唯一 |
| global_replace_mode | str | 否 | 是否全局替換 | 枚舉值:on,off |
| pattern | str | 是 | uri匹配模式 | 匹配模式+改寫后uri+改寫對象需唯一 |
| replace | str | 否 | 改寫后uri | 匹配模式+改寫后uri+改寫對象需唯一 |
| rewrite_mode | str | 否 | 改寫模式 | 枚舉值:encode(編碼),decode(解碼);不傳默認解碼 |
19)參數backorigin_arg_rewrite:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| id | str | 是 | 唯一標識 | id不可重復,格式為backorigin_arg_rewrite_時間戳,且id為backorigin_arg_rewrite_condition中key值 |
| keep_args_order | str | 否 | 保持參數順序開關 | 枚舉值:on,off;默認off |
| need_encode_args | str | 否 | 是否參數編碼 | 枚舉值:on,off;默認on。當且僅當keep_args_order=on時有效 |
| mode | str | 否 | 改寫參數模式 | 枚舉值:add(追加),cover(覆蓋);默認add |
| args | dict | 否 | 參數 | 默認格式:{key1:value1, key2:value2} ,當改寫參數模式為add時,必填 |
| priority | int | 否 | 優先級 | 取值范圍[1,1000];默認10 |
20)參數dns_query:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| switch | int | 是 | 開關 | 枚舉值:0(關閉),1(開啟) |
| query_type | str | 否 | 回源域名解析方式 | 枚舉值:ipv4_first(優先v4解析,失敗重試v6),ipv6_first(優先v6解析,失敗重試v4),ipv4_only(僅按v4解析),client_first(按來源IP類型解析,支持重試);當switch=1時,必填 |
21)參數error_page_single:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| code | string | 是 | 錯誤狀態碼,多個用英文逗號隔開 | |
| url | string | 是 | 跳轉頁面,總長度最小為16位,須以//或者//開頭 | |
| location_code | string | 否 | 跳轉狀態碼,默認302 | |
| priority | int | 否 | 優先級,默認10 |
22)參數define_redirect:
| 參數 | 類型 | 是否必填 | 名稱 | 說明 |
|---|---|---|---|---|
| id | string | 是 | 唯一標識,且id為define_redirect_condition中key值 | |
| pattern | string | 否 | 待改寫PATH | |
| replacement | string | 是 | 目標PATH | |
| code | string | 否 | 跳轉狀態碼;默認302,且只允許3xx | |
| priority | int | 否 | 優先級,默認10 |
返回參數說明:
| 參數 | 類型 | 是否必傳 | 名稱及描述 |
|---|---|---|---|
| code | int | 是 | 狀態碼,成功100000 |
| message | string | 是 | 描述信息,成功返回success,其他返回異常信息描述 |
示例:
請求路徑://cdnapi-global.ctapi.daliqc.cn/domain/update-domain
請求參數:
{
"domain":"sd55sd12.baidu.daliqc.cn",
"product_code":"006",
"ipv6_enable":2,
"origin":[
{
"role":"master",
"port":80,
"origin":"1.1.1.1",
"weight":10
}
],
"req_host":"www.test.daliqc.cn",
"black_referer":{
"allow_list":[
"www.test1.daliqc.cn"
],
"allow_empty":"on",
"referer_empty_protocol":"on"
},
"user_agent":{
"type":0,
"ua":[
"linux",
"windows"
]
},
"filetype_ttl":[
{
"ttl":300,
"file_type":"ts,mp4",
"cache_type":2,
"mode":0,
"cache_with_args":0
}
],
"ip_black_list":"1.1.1.1,2.2.2.2,3.3.3.3",
"resp_headers":[
{
"value":"reqheadertest",
"key":"Test"
}
],
"https_status":"off",
"cert_name":"cert_009",
"https_basic":{
"https_force":"on",
"origin_protocol":"https"
},
"basic_conf":{
"follow_302":1,
"use_http2":1,
"http_origin_port":80,
"https_origin_port":8080
},
"limit_speed_uri":[
{
"id":"116576155090830",
"unit":"Kb/s",
"args":"good",
"weight":2
}
],
"limit_speed_uri_condition":{
"116576155090830":[
{
"mode":1,
"content":"/sss"
}
]
},
"limit_speed_const":[
{
"id":"116576155090830",
"unit":"Mb/s",
"rate":1,
"weight":2
}
],
"limit_speed_const_condition":{
"116576155090830":[
{
"mode":1,
"content":"/sss"
}
]
},
"ssl":"TLSv1",
"ssl_stapling":"on",
"entry_limits":[
{
"id":"123abc",
"limit_element":"entry_limits",
"frequency_threshold":0,
"frequency_time_range":3600,
"forbidden_duration":1000,
"forbidden_duration_unit":"s",
"forbidden_code":0,
"white_ip_control":[
"1.1.1.11",
"58.14.0.0/15",
"240e:94a:4001::3007"
],
"priority":100
},
{
"id":"456abc",
"limit_element":"entry_limits",
"frequency_threshold":1000,
"frequency_time_range":3000,
"forbidden_duration":1000,
"forbidden_duration_unit":"millis",
"forbidden_code":123,
"white_ip_control":[
"192.168.1.1",
"58.14.0.0/15",
"240e:94a:4001::3007"
],
"priority":1
}
],
"entry_limits_condition":{
"123abc":[
{
"mode":1,
"content":"/test1,/test2"
}
],
"456abc":[
{
"mode":4,
"content":"/test3$,/test4"
}
]
},
"cus_gzip":[
{
"id":"123abc",
"min_length":"1k",
"file_type":"tar",
"type":1,
"http_version":"1.1",
"vary":"on",
"max_length":"1m"
},
{
"id":"123abcd",
"min_length":"1M",
"file_type":"zip",
"type":0,
"http_version":"1.0",
"vary":"off",
"max_length":"1000M"
}
],
"cus_gzip_condition":{
"123abc":[
{
"mode":1,
"content":"/test1,/test2"
}
],
"123abcd":[
{
"mode":4,
"content":"/test3,/test4"
}
]
},
"cachekey_args":[
{
"id":"cachekey_args1234561231",
"ignore":0,
"is_with_args":1,
"mode":1,
"args":" ",
"priority":10,
"ignore_args":"xxx",
"subject":"xxx",
"pattern":"xxx",
"replace":"xxx"
},
{
"id":"cachekey_args123456abd@12"
}
],
"cachekey_args_condition":{
"cachekey_args123456abd@12":[
{
"mode":2,
"content":"/"
}
]
}
}
返回結果:
{
"code": 100000,
"message": "success"
}
錯誤碼請參考:參數code和message含義