全部產品
Search
文件中心

ApsaraVideo VOD:網域名稱配置功能函數

更新時間:Jul 13, 2024

調用BatchSetVodDomainConfigs可以實現網域名稱的大量設定,本文為您介紹該API可以配置哪些功能及功能參數用法。

基礎配置

ipv6

  • 功能說明:IPv6訪問配置,該功能詳細介紹請參見配置IPv6

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    switch

    String

    是否開啟IPv6訪問:

    • on:開啟。

    • off:關閉。

    on

    region

    String

    開啟IPv6功能的地區,支援星號(*)。

    說明
    • 星號(*)表示所有地區都開啟IPv6(目前僅支援針對所有地區都開啟IPv6,如果需要僅針對某個特定地區開啟IPv6,請提交工單申請)。

    • 不傳該參數,表示預設所有地區都開啟IPv6。

    *

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "switch",
                "argValue": "on"
            }, {
                "argName": "region",
                "argValue": "*"
            }],
            "functionName": "ipv6"
        }],
        "DomainNames": "example.com"
    }

回源配置

set_req_host_header

  • 功能說明:配置預設回源HOST,該功能詳細介紹請參見回源HOST

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    domain_name

    String

    回源HOST頭內容。

    example.com

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "domain_name",
                "argValue": "example.com"
            }],
            "functionName": "set_req_host_header"
        }],
        "DomainNames": "example.com"
    }

forward_scheme

  • 功能說明:配置回源協議,當前僅支援協議跟隨回源,該功能詳細介紹請參見協議跟隨回源

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟回源協議:

    • on:開啟。

    • off:關閉。

    on

    scheme_origin

    String

    回源類型,取值:

    • http:CDN以HTTP協議回源。

    • https:CDN以HTTPS協議回源。

    • follow(跟隨):用戶端以HTTP或者HTTPS協議請求CDN,CDN跟隨用戶端的協議請求來源站點。

    說明

    scheme_origin不配置時,預設取值為follow。

    follow

    scheme_origin_port

    String

    回源自訂連接埠,需要與scheme_origin參數搭配使用,取值:

    • scheme_origin取值為http時,只需要配置一個HTTP協議的回源連接埠,例如:80。

    • scheme_origin取值為https時,只需要配置一個HTTPS協議的回源連接埠,例如:443。

    • scheme_origin取值為follow時,需要同時配置HTTP協議和HTTPS協議的回源連接埠,中間用半形冒號(:)分隔,例如:80:443。

    80:443

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }, {
                "argName": "scheme_origin",
                "argValue": "follow"
            }],
            "functionName": "forward_scheme"
        }],
        "DomainNames": "example.com"
    }

l2_oss_key

  • 功能說明:配置私人Bucket回源,該功能詳細介紹請參見私人Bucket回源

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    private_oss_auth

    String

    是否開啟私人Bucket回源:

    • on:開啟。

    • off:關閉。

    功能開啟以後,系統會自動設定STS安全性權杖,配置更簡單,但是僅支援CDN網域名稱回源到同一個阿里雲帳號下的OSS私人Bucket。關於STS安全性權杖更多資訊,請參見臨時訪問憑證STS概念

    on

    perm_private_oss_tbl

    String

    永久安全性權杖配置,配置格式是access_id=123 access_secret=123abc(中間用空格分隔)。

    配置了永久安全性權杖以後,除了支援CDN網域名稱回源到同一個阿里雲帳號下的OSS私人Bucket,還支援CDN網域名稱回源到其他阿里雲帳號下的OSS私人Bucket。關於永久安全性權杖更多資訊,請參見建立AccessKey

    access_id=123 access_secret=123abc

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "private_oss_auth",
                "argValue": "on"
            },{
                "argName": "perm_private_oss_tbl",
                "argValue": "access_id=123 access_secret=123abc"
            }],
            "functionName": "l2_oss_key"
        }],
        "DomainNames": "example.com"
    }

https_origin_sni

  • 功能說明:配置回源SNI,該功能詳細介紹請參見配置回源SNI

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enabled

    String

    是否開啟回源SNI功能:

    • on:開啟。

    • off:關閉。

    on

    https_origin_sni

    String

    回源請求攜帶的SNI資訊(即回源請求需要訪問的來源站點網站地址)。

    origin.example.com

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "https_origin_sni",
                "argValue": "origin.example.com"
            }, {
                "argName": "enabled",
                "argValue": "on"
            }],
            "functionName": "https_origin_sni"
        }],
        "DomainNames": "example.com"
    }

forward_timeout

  • 功能說明:配置回源請求逾時時間,該功能詳細介紹請參見配置回源HTTP請求逾時時間

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    forward_timeout

    Integer

    請求逾時時間,單位:秒。

    說明

    建議設定時間小於100秒。

    30

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "forward_timeout",
                "argValue": "30"
            }],
            "functionName": "forward_timeout"
        }],
        "DomainNames": "example.com"
    }

advanced_origin

  • 功能說明:配置進階回源,該功能詳細介紹請參見進階回源

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    variable_type

    String

    變數類型,取值:

    • header:使用者請求中攜帶的header(request header)。

    • arg:使用者請求URL中攜帶的參數(query string parameter)。

    • uri:使用者請求URL中攜帶的路徑(path)。

    • cookie:使用者請求中攜帶的cookie(request cookie)。

    uri

    variable

    String

    變數名稱。

    說明

    variable_type=uri的情況下,variable只能固定=uri。

    uri

    conditions

    String

    條件,取值:

    • ==:表示“等於”。

    • !=:表示“不等於”。

    ==

    value

    String

    變數的取值。

    /image

    origin

    String

    回源查詢DNS使用的網域名稱(即使用者請求中對應的變數值,匹配後需要回源到指定的來源站點地址)。

    origin.example.com

  • 配置樣本:

    {
     "Functions": [{
      "functionArgs": [{
       "argName": "conditions",
       "argValue": "=="
      }, {
       "argName": "variable_type",
       "argValue": "uri"
      }, {
       "argName": "value",
       "argValue": "/image"
      }, {
       "argName": "origin",
       "argValue": "origin.example.com"
      }, {
       "argName": "variable",
       "argValue": "uri"
      }],
      "functionName": "advanced_origin"
     }],
     "DomainNames": "example.com",
    }

follow_302

  • 功能說明:配置回源302跟隨,該功能詳細介紹請參見配置回源301/302跟隨

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟回源302跟隨:

    • on:開啟。

    • off:關閉。

    on

    max_tries

    Integer

    302跟隨次數上限。

    • 預設值:2。

    • 取值範圍:[1,5]。

    說明

    回源次數-1(次)=302跟隨次數,即預設的回源次數上限為3,可配置範圍是[2,6]。

    2

    retain_args

    String

    302跟隨時是否保留原請求參數返回目標源:

    • on:保留。

    • off(預設):不保留。

    off

    retain_header

    String

    302跟隨時是否保留原要求標頭回目標源:

    • on:保留。

    • off(預設):不保留。

    off

    response_header

    String

    302跟隨回應標頭,表示來源站點給CDN的302跟隨回應標頭的名稱,該回應標頭名稱預設為Location。

    X-Alicdn-Redirect

    retain_host

    String

    302跟隨保留回源網域名稱,當開啟時,表示CDN在302跟隨時保留回源網域名稱,只在跟隨到目標網域名稱時生效。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    modify_host

    String

    302跟隨修改回源網域名稱,表示CDN在302跟隨時修改回源網域名稱,只在跟隨到目標網域名稱時生效。預設不修改回源網域名稱。

    example.com

    cache

    String

    302跟隨緩衝跟隨結果,當開啟時,表示CDN在302跟隨時緩衝同URL的跟隨結果,提升CDN的響應效能。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    expired_time

    Integer

    302跟隨緩衝跟隨結果的逾時時間,表示CDN在302跟隨時緩衝同URL的跟隨結果的逾時時間,需要配合緩衝功能一起使用,單位秒,預設:3600秒

    7200

    follow_origin_host

    String

    302跟隨回源host使用來源站點網域名稱,當開啟時,表示CDN會使用來源站點網域名稱作為回源host(即使主備切換也會使用最新的來源站點網域名稱)。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    follow_5xx_retry_origin

    String

    來源站點主備切換,當開啟時,表示CDN如果收到來源站點響應的5xx狀態代碼,會切換到下一個可用的來源站點。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }, {
                "argName": "max_tries",
                "argValue": 2
            }, {
                "argName": "retain_args",
                "argValue": "off"
            }, {
                "argName": "retain_header",
                "argValue": "off"
    }, {
                "argName": "response_header",
                "argValue": "X-Alicdn-Redirect"
    }, {
                "argName": "retain_header",
                "argValue": "off"
    }, {
                "argName": "modify_host",
                "argValue": "example.com"
    }, {
                "argName": "cache",
                "argValue": "off"
    }, {
                "argName": "expired_time",
                "argValue": "7200"
    }, {
                "argName": "follow_origin_host",
                "argValue": "off"
    }, {
                "argName": "follow_5xx_retry_origin",
                "argValue": "off"
            }],
            "functionName": "follow_302"
        }],
        "DomainNames": "example.com"
    }

ipv6_origin

  • 功能說明:配置IPv6回源,該功能詳細介紹請參見配置IPv6回源

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟IPv6回源功能。

    • on:開啟。

    • off:關閉。

    說明

    開啟IPv6回源功能後,CDN回源側將提供IPv6服務。

    • CDN節點和來源站點都具備可用的IPv6地址,則使用IPv6建連。

    • 以下情境使用IPv4建連:

      • CDN節點不具備可用的IPv6地址。

      • 來源站點不具備可用的IPv6地址。

      • CDN節點和來源站點都不具備可用的IPv6地址。

    on

    follow

    String

    是否開啟回源跟隨用戶端IP協議版本功能。

    • on:開啟。

    • off:關閉。

    說明

    開啟回源跟隨用戶端IP協議版本功能後,CDN回源將會跟隨用戶端請求使用的IP協議版本。

    • 用戶端請求使用IPv6,則CDN優先回源IPv6來源站點,如果沒有IPv6來源站點,則使用IPv4來源站點。

    • 用戶端請求使用IPv4,則CDN優先回源IPv4來源站點,如果沒有IPv4來源站點,則使用IPv6來源站點。

    on

    ipv6_v4_mix_used

    String

    是否開啟“來源站點IPv4地址/IPv6地址輪詢”功能。

    • on:開啟。

    • off:關閉。

    說明
    • “來源站點IPv4地址/IPv6地址輪詢”功能與“IPv6回源”、“回源跟隨用戶端IP協議版本”這兩個功能是互斥的,“回源v4/v6輪詢”功能一旦開啟,“IPv6回源”、“回源跟隨用戶端IP協議版本”這兩個功能就會失效。

    • “來源站點IPv4地址/IPv6地址輪詢”功能的作用是不論用戶端請求使用的是IPv4還是IPv6,也不論來源站點有幾個IPv4地址、幾個IPv6地址,都會統一使用輪詢方式回源到各個來源站點地址。

    • 如果IPv4、IPv6地址配置了權重比例,那麼還會按照權重比例回源。

    off

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            },{
                "argName": "follow",
                "argValue": "on"
            }],
            "functionName": "ipv6_origin"
        }],
        "DomainNames": "example.com"
    }

origin_request_header

  • 功能說明:配置回源HTTP要求標頭,該功能詳細介紹請參見配置HTTP要求標頭

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    header_operation_type

    String

    要求標頭操作,取值:

    • add:添加。

    • delete:刪除。

    • modify:變更。

    • rewrite:替換。

    add

    header_name

    String

    要求標頭名稱。

    Accept-Encoding

    header_value

    String

    要求標頭值。一個要求標頭參數中可以配置多個值,多個值用英文逗號(,)分隔。

    gzip

    duplicate

    String

    是否允許重複添加名稱相同的要求標頭。當header_operation_type使用add時(即執行增加操作),需要設定是否允許重複:

    • on:允許。

    • off:不允許。

    off

    header_source

    String

    尋找需要替換的參數值。當header_operation_type使用rewrite時(即執行替換操作),需要設定該參數,取值支援Regex。

    value1

    header_destination

    String

    替換後的參數值。當header_operation_type使用rewrite時(即執行替換操作),需要設定該參數。

    value123

    match_all

    String

    設定匹配模式。當header_operation_type使用rewrite時(即執行替換操作),需要設定匹配模式:

    • on:匹配所有(所有匹配上的值都會被替換)。

    • off:僅匹配第一個(只有第一個匹配上的值會被替換)。

    off

  • 配置樣本:為加速網域名稱example.com添加自訂回源要求標頭,要求標頭名稱=Accept-Encoding,要求標頭值=gzip。

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "header_operation_type",
                "argValue": "add"
            }, {
                "argName": "header_name",
                "argValue": "Accept-Encoding"
            }, {
                "argName": "header_value",
                "argValue": "gzip"
            }, {
                "argName": "duplicate",
                "argValue": "off"
            }],
            "functionName": "origin_request_header"
        }],
        "DomainNames": "example.com"
    }

origin_response_header

  • 功能說明:配置回源HTTP回應標頭,該功能詳細介紹請參見配置HTTP回應標頭

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    header_operation_type

    String

    回應標頭操作,取值:

    • add:添加。

    • delete:刪除。

    • modify:變更。

    • rewrite:替換。

    add

    header_name

    String

    回應標頭名稱。

    Cache-Control

    header_value

    String

    回應標頭值。一個回應標頭參數中可以配置多個值,多個值用英文逗號(,)分隔。

    no-cache

    duplicate

    String

    是否允許重複添加名稱相同的回應標頭。當header_operation_type使用add時(即執行增加操作),需要設定是否允許重複:

    • on:允許重複。

    • off:不允許重複。

    off

    header_source

    String

    尋找需要替換的參數值。當header_operation_type使用rewrite時(即執行替換操作),需要設定該參數,取值支援Regex。

    value1

    header_destination

    String

    替換後的參數值。當header_operation_type使用rewrite時(即執行替換操作),需要設定該參數。

    value123

    match_all

    String

    匹配模式。當header_operation_type使用rewrite時(即執行替換操作),需要設定匹配模式:

    • on:匹配所有(所有匹配上的值都會被替換)。

    • off:僅匹配第一個(只有第一個匹配上的值會被替換)。

    off

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "header_operation_type",
                "argValue": "add"
            }, {
                "argName": "header_name",
                "argValue": "Cache-Control"
            }, {
                "argName": "header_value",
                "argValue": "no-cache"
            }, {
                "argName": "duplicate",
                "argValue": "off"
            }],
            "functionName": "origin_response_header"
        }],
        "DomainNames": "example.com"
    }

back_to_origin_url_rewrite

  • 功能說明:改寫回源URL,該功能詳細介紹請參見改寫回源URL

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    source_url

    String

    被重寫的URL。

    ^/hello$

    target_url

    String

    重寫的目標URL。

    /hello/test

    flag

    String

    改寫操作的執行規則,取值:

    • 空:執行完該條規則後,後續rewrite規則會繼續執行。

    • break:執行完該條規則後,後續rewrite規則不再執行。

    • enhance_break:類似break,區別在於會帶著參數一起進行處理,並且針對flv直播也會生效。

    break

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "flag",
                "argValue": "break"
            }, {
                "argName": "source_url",
                "argValue": "^/hello$"
            }, {
                "argName": "target_url",
                "argValue": "/hello/test"
            }],
            "functionName": "back_to_origin_url_rewrite"
        }],
        "DomainNames": "example.com",
    }

緩衝配置

filetype_based_ttl_set

  • 功能說明:設定檔到期時間,該功能詳細介紹請參見緩衝配置

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    ttl

    Integer

    緩衝時間,單位為秒,取值範圍是1~99999999(3年多一些)。

    500000

    file_type

    String

    檔案類型,區分大小寫。多個檔案類型用半形逗號(,)分隔。例如jpg,txt。

    jpg

    weight

    Integer

    權重。取值:1~99。

    說明

    預設為1,數字越大優先順序越高。

    1

    swift_origin_cache_high

    String

    來源站點響應緩衝策略優先,當開啟時,表示在來源站點響應緩衝相關頭(比如Cache-Control、Pragma等)的時候,來源站點的緩衝策略優先生效。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    swift_no_cache_low

    String

    忽略來源站點不緩衝回應標頭,當開啟時,表示忽略來源站點的以下回應標頭(均表示不緩衝)。

    • Cache-Control: no-store

    • Cache-Control: no-cache

    • Cache-Control: max-age=0

    • Pragme: no-cache

    可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    swift_follow_cachetime

    String

    用戶端跟隨CDN緩衝策略,當開啟時,表示將最終生效的CDN緩衝策略響應給用戶端。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "file_type",
                "argValue": "jpg"
            }, {
                "argName": "weight",
                "argValue": "1"
            }, {
                "argName": "ttl",
                "argValue": "500000"
            }, {
                "argName": "swift_origin_cache_high",
                "argValue": "off"
            }, {
                "argName": "swift_no_cache_low",
                "argValue": "off"
            }, {
                "argName": "swift_follow_cachetime",
                "argValue": "off"
            }],
            "functionName": "filetype_based_ttl_set"
        }],
        "DomainNames": "example.com"
    }
    

path_based_ttl_set

  • 功能說明:配置目錄到期時間,該功能詳細介紹請參見緩衝配置

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    ttl

    Integer

    緩衝時間,單位為秒,取值範圍是1~99999999(3年多一些)。

    500000

    path

    String

    目錄,必須以正斜線(/)開頭。

    /example/demo

    weight

    Integer

    權重。取值:1~99。

    說明

    預設為1,數字越大優先順序越高。

    1

    swift_origin_cache_high

    String

    來源站點響應緩衝策略優先,當開啟時,表示在來源站點響應緩衝相關頭(比如Cache-Control、Pragma等)的時候,來源站點的緩衝策略優先生效。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    swift_no_cache_low

    String

    忽略來源站點不緩衝回應標頭,當開啟時,表示忽略來源站點的以下回應標頭(均表示不緩衝)。

    • Cache-Control: no-store

    • Cache-Control: no-cache

    • Cache-Control: max-age=0

    • Pragme: no-cache

    可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    swift_follow_cachetime

    String

    用戶端跟隨CDN緩衝策略,當開啟時,表示將最終生效的CDN緩衝策略響應給用戶端。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "path",
                "argValue": "/example/demo"
            }, {
                "argName": "weight",
                "argValue": "1"
            }, {
                "argName": "ttl",
                "argValue": "500000"
            }, {
                "argName": "swift_origin_cache_high",
                "argValue": "off"
            }, {
                "argName": "swift_no_cache_low",
                "argValue": "off"
            }, {
                "argName": "swift_follow_cachetime",
                "argValue": "off"
            }],
            "functionName": "path_based_ttl_set"
        }],
        "DomainNames": "example.com"
    }

filetype_force_ttl_code

  • 功能說明:設定檔狀態代碼到期時間,該功能詳細介紹請參見狀態代碼到期時間

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    file_type

    String

    檔案類型,區分大小寫,多個用半形逗號(,)分隔,例如:jpg,txt。

    jpg

    code_string

    String

    狀態代碼及其緩衝時間,單位為秒,取值範圍是1~99999999(3年多一些),多個用半形逗號(,)分隔。例如:302=0,301=0,4xx=2。

    403=10

    swift_origin_cache_high

    String

    來源站點響應緩衝策略優先,當開啟時,表示在來源站點響應緩衝相關頭(比如Cache-Control、Pragma等)的時候,來源站點的緩衝策略優先生效。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    swift_no_cache_low

    String

    忽略來源站點不緩衝回應標頭,當開啟時,表示忽略來源站點的以下回應標頭(均表示不緩衝)。

    • Cache-Control: no-store

    • Cache-Control: no-cache

    • Cache-Control: max-age=0

    • Pragme: no-cache

    可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    swift_follow_cachetime

    String

    用戶端跟隨CDN緩衝策略,當開啟時,表示將最終生效的CDN緩衝策略響應給用戶端。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "file_type",
                "argValue": "jpg"
            }, {
                "argName": "code_string",
                "argValue": "403=10"
           }, {
                "argName": "swift_origin_cache_high",
                "argValue": "off"
            }, {
                "argName": "swift_no_cache_low",
                "argValue": "off"
            }, {
                "argName": "swift_follow_cachetime",
                "argValue": "off"
            }],
            "functionName": "filetype_force_ttl_code"
        }],
        "DomainNames": "example.com"
    }

path_force_ttl_code

  • 功能說明:配置路徑狀態代碼到期時間,該功能詳細介紹請參見狀態代碼到期時間

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    path

    String

    目錄,必須以正斜線(/)開頭,例如:/image。

    /example/demo

    code_string

    String

    狀態代碼及其緩衝時間,單位為秒,取值範圍是1~99999999(3年多一些),多個用半形逗號(,)分隔。例如:302=0,301=0,4xx=2。

    403=10,404=15

    swift_origin_cache_high

    String

    來源站點響應緩衝策略優先,當開啟時,表示在來源站點響應緩衝相關頭(比如Cache-Control、Pragma等)的時候,來源站點的緩衝策略優先生效。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    swift_no_cache_low

    String

    忽略來源站點不緩衝回應標頭,當開啟時,表示忽略來源站點的以下回應標頭(均表示不緩衝)。

    • Cache-Control: no-store

    • Cache-Control: no-cache

    • Cache-Control: max-age=0

    • Pragme: no-cache

    可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

    swift_follow_cachetime

    String

    用戶端跟隨CDN緩衝策略,當開啟時,表示將最終生效的CDN緩衝策略響應給用戶端。可以配置的值為:

    • on:開啟

    • off(預設):關閉

    off

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "path",
                "argValue": "/example/demo"
            }, {
                "argName": "code_string",
                "argValue": "403=10,404=15"
            }, {
                "argName": "swift_origin_cache_high",
                "argValue": "off"
            }, {
                "argName": "swift_no_cache_low",
                "argValue": "off"
            }, {
                "argName": "swift_follow_cachetime",
                "argValue": "off"
            }],
            "functionName": "path_force_ttl_code"
        }],
        "DomainNames": "example.com"
    }

set_resp_header

  • 功能說明:配置自訂HTTP回應標頭,該功能詳細介紹請參見自訂HTTP回應標頭

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    key

    String

    回應標頭。

    Cache-Control

    value

    String

    回應標頭值,多個值之間用英文逗號(,)分隔。

    說明

    如果要刪除某個回應標頭,請設定回應標頭的值為null。

    no-cache

    header_operation_type

    String

    要求標頭操作,取值:

    • add:添加。

    • delete:刪除。

    • modify:變更。

    • rewrite:替換。

    add

    duplicate

    String

    是否允許重複添加名稱相同的要求標頭。當header_operation_type使用add時(即執行增加操作),需要設定是否允許重複:

    • on:允許重複。

    • off:不允許重複。

    off

    header_source

    String

    尋找需要替換的參數值。當header_operation_type使用rewrite時(即執行替換操作),需要設定該參數,取值支援Regex。

    value1

    header_destination

    String

    替換後的參數值。當header_operation_type使用rewrite時(即執行替換操作),需要設定該參數。

    value123

    match_all

    String

    設定匹配模式。當header_operation_type使用rewrite時(即執行替換操作),需要設定匹配模式:

    • on:匹配所有(所有匹配上的值都會被替換)。

    • off:僅匹配第一個(只有第一個匹配上的值會被替換)。

    /

    access_origin_control

    String

    是否開啟跨域訪問:

    • on:開啟CDN節點對使用者請求的跨域校正。

    • off:關閉該功能。

    /

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "header_operation_type",
                "argValue": "add"
            }, {
                "argName": "key",
                "argValue": "Cache-Control"
            }, {
                "argName": "value",
                "argValue": "no-cache"
            }, {
                "argName": "duplicate",
                "argValue": "off"
            }],
            "functionName": "set_resp_header"
        }],
        "DomainNames": "example.com"
    }

error_page

  • 功能說明:配置自訂頁面,該功能詳細介紹請參見自訂頁面

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    error_code

    Integer

    錯誤碼。

    404

    rewrite_page

    String

    重新導向頁面。

    http://example.aliyundoc.com/error404.html

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "error_code",
                "argValue": "404"
            }, {
                "argName": "rewrite_page",
                "argValue": "http://example.aliyundoc.com/error404.html"
            }],
            "functionName": "error_page"
        }],
        "DomainNames": "example.com"
    }

rewrite_host

  • 功能說明:共用快取。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    share_host

    String

    可以與當前網域名稱共用快取的目標網域名稱。該配置不修改使用者請求的回源HOST,只是在查詢快取資源的時候,使用share_host值來產生查詢用的cachekey。

    example.com

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "share_host",
                "argValue": "example.com"
            }],
            "functionName": "rewrite_host"
        }],
        "DomainNames": "example.com"
    }

HTTPS配置

https_option

  • 功能說明:配置HTTPS基礎參數(目前支援配置HTTP/2),該功能詳細介紹請參見配置HTTP/2

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    http2

    String

    是否開啟HTTP2開關:

    • on:開啟。

    • off:關閉。

    on

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "http2",
                "argValue": "on"
            }],
            "functionName": "https_option"
        }],
        "DomainNames": "example.com"
    }

http_force

  • 功能說明:配置強制HTTP跳轉,該功能詳細介紹請參見配置強制跳轉

    說明
    • 強制HTTP跳轉功能與強制HTTPS跳轉功能(功能函數:https_force)存在衝突,只能二選其一進行配置。

    • 如果已經配置了其中一個功能(注意:如果功能函數存在功能開關配置參數,在參數被置為off的情況下,也屬於已存在配置),則必須刪除已經添加的功能配置(您可以通過調用DeleteVodSpecificConfig - 刪除網域名稱配置介面來刪除網域名稱的指定配置),然後才能給另外一個功能添加配置。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟強制HTTP跳轉:

    • on:開啟。

    • off:關閉。

    on

    http_rewrite

    String

    跳轉方式,支援301、308狀態代碼:

    • 301:GET請求方式不會發生變更,其他請求方式有可能會變更為GET請求方式。

    • 308:請求方式和訊息主體都不發生變化。

    301

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }, {
                "argName": "http_rewrite",
                "argValue": "301"
            }],
            "functionName": "http_force"
        }],
        "DomainNames": "example.com"
    }

https_force

  • 功能說明:配置強制HTTPS跳轉,該功能詳細介紹請參見配置強制跳轉

    說明
    • 強制HTTPS跳轉功能與強制HTTP跳轉功能(功能函數:http_force)存在衝突,只能二選其一進行配置。

    • 如果已經配置了其中一個功能(注意:如果功能函數存在功能開關配置參數,在參數被置為off的情況下,也屬於已存在配置),則必須刪除已經添加的功能配置(您可以通過調用DeleteVodSpecificConfig - 刪除網域名稱配置介面來刪除網域名稱的指定配置),然後才能給另外一個功能添加配置。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟強制HTTPS跳轉:

    • on:開啟。

    • off:關閉。

    on

    https_rewrite

    String

    跳轉方式,支援301、308狀態代碼:

    • 301:GET請求方式不會發生變更,其他請求方式有可能會變更為GET請求方式。

    • 308:請求方式和訊息主體都不發生變化。

    301

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }, {
                "argName": "https_rewrite",
                "argValue": "301"
            }],
            "functionName": "https_force"
        }],
        "DomainNames": "example.com"
    }

https_tls_version

  • 功能說明:配置TLS協議版本,該功能詳細介紹請參見配置TLS版本控制

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    tls10

    String

    是否開啟TLSv1.0:

    • on(預設):開啟。

    • off:關閉。

    on

    tls11

    String

    是否開啟TLSv1.1:

    • on(預設):開啟。

    • off:關閉。

    on

    tls12

    String

    是否開啟TLSv1.2:

    • on(預設):開啟。

    • off:關閉。

    on

    tls13

    String

    是否開啟TLSv1.3:

    • on(預設):開啟。

    • off:關閉。

    on

    ciphersuitegroup

    String

    密碼編譯演算法套件組:

    • all(預設):全部密碼編譯演算法套件。

    • strict:強密碼編譯演算法套件。

    • custom:自訂密碼編譯演算法套件。

    all

    String

    密碼編譯演算法套件,配合ciphersuitegroup參數(自訂密碼編譯演算法套件)使用,可以配置多個密碼編譯演算法套件,中間用英文逗號分隔。

    TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

  • 配置樣本:

    • 預設配置,開啟TLS1.0、1.1、1.2,使用全部密碼編譯演算法套件。

      {
          "Functions": [{
              "functionArgs": [
                  {
                    "ArgValue": "on",
                    "ArgName": "tls10"
                  },
                  {
                    "ArgValue": "on",
                    "ArgName": "tls11"
                  },
                  {
                    "ArgValue": "on",
                    "ArgName": "tls12"
                  },
                  {
                    "ArgValue": "off",
                    "ArgName": "tls13"
                  },
                  {
                    "ArgValue": "all",
                    "ArgName": "ciphersuitegroup"
                  }
                ],
              "functionName": "https_tls_version"
          }],
          "DomainNames": "example.com"
      }
    • 開啟TLS1.2、1.3,使用強密碼編譯演算法套件。

      {
          "Functions": [{
              "functionArgs": [
                  {
                    "ArgValue": "off",
                    "ArgName": "tls10"
                  },
                  {
                    "ArgValue": "off",
                    "ArgName": "tls11"
                  },
                  {
                    "ArgValue": "on",
                    "ArgName": "tls12"
                  },
                  {
                    "ArgValue": "on",
                    "ArgName": "tls13"
                  },
                  {
                    "ArgValue": "strict",
                    "ArgName": "ciphersuitegroup"
                  }
                ],
              "functionName": "https_tls_version"
          }],
          "DomainNames": "example.com"
      }
    • 開啟TLS1.2、1.3,使用自訂密碼編譯演算法套件。

      {
          "Functions": [{
              "functionArgs": [
                  {
                    "ArgValue": "off",
                    "ArgName": "tls10"
                  },
                  {
                    "ArgValue": "off",
                    "ArgName": "tls11"
                  },
                  {
                    "ArgValue": "on",
                    "ArgName": "tls12"
                  },
                  {
                    "ArgValue": "on",
                    "ArgName": "tls13"
                  },
                  {
                    "ArgValue": "custom",
                    "ArgName": "ciphersuitegroup"
                  },
                  {
                    "ArgValue": "TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
                    "ArgName": "ciphersuite"
                  }
                ],
              "functionName": "https_tls_version"
          }],
          "DomainNames": "example.com"
      }

存取控制

referer_white_list_set

  • 功能說明:配置Referer白名單,該功能詳細介紹請參見配置Referer防盜鏈

    說明
    • Referer白名單功能與Referer黑名單功能(功能函數:referer_black_list_set)存在衝突,只能二選其一進行配置。

    • 如果已經配置了其中一個功能(注意:如果功能函數存在功能開關配置參數,在參數被置為off的情況下,也屬於已存在配置),則必須刪除已經添加的功能配置(您可以通過調用DeleteVodSpecificConfig - 刪除網域名稱配置介面來刪除網域名稱的指定配置),然後才能給另外一個功能添加配置。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    refer_domain_allow_list

    String

    白名單列表,多個用半形逗號(,)分隔。

    example.aliyundoc.com,demo.aliyundoc.com

    allow_empty

    String

    是否允許空referer欄位訪問CDN資源。取值:

    • on:允許。

    • off(預設值):禁止。

    off

    redirect_url

    String

    重新導向URL,即使用者請求中的referer資訊未匹配上白名單列表,被攔截後不會再返回403,而是會返回302加Location頭,該項為Location頭的值,以 http:// 或者 https:// 開頭。

    http://www.example.com

    disable_ast

    String

    使用精確匹配模式,控制“白名單列表”項中填寫的網域名稱是否為精確匹配。如果勾選(on)則精確匹配網域名稱。

    • 取值為on時:

      • 支援精確匹配

        • 白名單列表填寫example.com,匹配example.com

        • 白名單列表填寫a*b.example.com,匹配a<任一字元>b.example.com

      • 不支援尾碼匹配

    • 取值為off(預設值)時:

      • 不支援精確匹配

      • 支援尾碼匹配

        • 白名單列表填寫example.com,匹配example.com<任一字元>.example.com

        • 白名單列表填寫a*b.example.com,匹配a<任一字元>b.example.com<任一字元>.a<任一字元>b.example.com

    off

    ignore_scheme

    String

    開啟忽略scheme。開啟後,如果使用者請求中的referer沒有帶上HTTP或HTTPS協議頭部,則依然當做有效referer進行處理。樣本:

    • 取值為on時,referer格式如下:

      referer: www.example.com

    • 取值為off(預設值)時,referer格式如下:

      referer: https://www.example.com

    off

  • 配置樣本:

    {
      "Functions": [
        {
          "functionArgs": [
            {
              "argName": "allow_empty",
              "argValue": "off"
            },
            {
              "argName": "refer_domain_allow_list",
              "argValue": "example.aliyundoc.com,demo.aliyundoc.com"
            },
            {
              "argName": "disable_ast",
              "argValue": "on"
            },
            {
              "argName": "ignore_scheme",
              "argValue": "on"
            },
            {
              "argName": "redirect_url",
              "argValue": "http://www.example.com"
            }
          ],
          "functionName": "referer_white_list_set"
        }
      ],
      "DomainNames": "example.com"
    }

referer_black_list_set

  • 功能說明:配置Referer黑名單,該功能詳細介紹請參見配置Referer防盜鏈

    說明
    • Referer黑名單功能與Referer白名單功能(功能函數:referer_white_list_set)存在衝突,只能二選其一進行配置。

    • 如果已經配置了其中一個功能(注意:如果功能函數存在功能開關配置參數,在參數被置為off的情況下,也屬於已存在配置),則必須刪除已經添加的功能配置(您可以通過調用DeleteVodSpecificConfig - 刪除網域名稱配置介面來刪除網域名稱的指定配置),然後才能給另外一個功能添加配置。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    refer_domain_deny_list

    String

    黑名單列表,多個用半形逗號(,)分隔。

    example.aliyundoc.com,demo.aliyundoc.com

    allow_empty

    String

    是否允許空referer欄位訪問CDN資源:

    • on:允許。

    • off:禁止。

    off

    redirect_url

    String

    重新導向URL,即使用者請求中的referer資訊匹配上黑名單列表,被攔截後不會再返回403,而是會返回302加Location頭,該項為Location頭的值,以 http:// 或者 https:// 開頭。

    http://www.example.com

    disable_ast

    String

    使用精確匹配模式,控制“黑名單列表”項中填寫的網域名稱是否為精確匹配。如果勾選(on)則精確匹配。

    • 取值為on時:

      • 支援精確匹配

        • 黑名單列表填寫example.com,匹配example.com

        • 黑名單列表填寫a*b.example.com,匹配a<任一字元>b.example.com

      • 不支援尾碼匹配

    • 取值為off(預設值)時:

      • 不支援精確匹配

      • 支援尾碼匹配

        • 黑名單列表填寫example.com,匹配example.com<任一字元>.example.com

        • 黑名單列表填寫a*b.example.com,匹配a<任一字元>b.example.com<任一字元>.a<任一字元>b.example.com

    off

    ignore_scheme

    String

    開啟忽略scheme。開啟後,如果使用者請求中的referer沒有帶上HTTP或HTTPS協議頭部,則依然當做有效referer進行處理。樣本:

    • 取值為on時,referer格式如下:

      referer: www.example.com

    • 取值為off(預設值)時,referer格式如下:

      referer: https://www.example.com

    off

  • 配置樣本:

    {
      "Functions": [
        {
          "functionArgs": [
            {
              "argName": "allow_empty",
              "argValue": "off"
            },
            {
              "argName": "refer_domain_deny_list",
              "argValue": "example.aliyundoc.com,demo.aliyundoc.com"
            },
            {
              "argName": "disable_ast",
              "argValue": "on"
            },
            {
              "argName": "ignore_scheme",
              "argValue": "on"
            },
            {
              "argName": "redirect_url",
              "argValue": "http://www.example.com"
            }
          ],
          "functionName": "referer_black_list_set"
        }
      ],
      "DomainNames": "example.com"
    }

aliauth

  • 功能說明:配置URL鑒權,該功能詳細介紹請參見URL鑒權

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    auth_m3u8

    String

    開啟m3u8內容改寫,對m3u8裡面的ts補齊對應的鑒權,可以避免ts的訪問鑒權失敗,取值on(預設值)和off。

    on

    auth_type

    String

    鑒權類型。取值:

    • no_auth:無鑒權。

    • type_a:鑒權方式A。

    • type_b:鑒權方式B。

    • type_c:鑒權方式C。

    type_a

    auth_key1

    String

    鑒權key1(16~128個字元支援大寫字母、小寫字母和數字)。

    1234567890123456789

    auth_key2

    String

    鑒權key2(16~128個字元支援大寫字母、小寫字母和數字)。

    1234567890123456789

    ali_auth_delta

    Integer

    鑒權URL有效時間長度,預設1800,單位:秒。

    1800

    req_auth_ip_white

    String

    白名單例外IP列表,白名單中的IP不去進行鑒權校正。

    支援輸入多個IP地址,多個IP地址之間使用英文逗號分隔。

    192.168.0.1

    req_auth_ip_acl_xfwd

    String

    用戶端例外IP的提取方式,取值支援:

    • on:該模式為預設模式。該模式校正的是使用者請求中x-forwarded-for要求標頭攜帶的左邊第一個IP,這個IP對應用戶端真實IP。

    • off:該模式校正的是用戶端與CDN節點之間建連使用的IP。

    • all:同時校正以下兩個IP地址資訊:

      • 使用者請求中x-forwarded-for要求標頭攜帶的左邊第一個IP,即用戶端真實IP。

      • 用戶端與CDN節點之間建連使用的IP。

    all

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "auth_type",
                "argValue": "type_a"
            }, {
                "argName": "auth_key1",
                "argValue": "1234567890123456789"
            }, {
                "argName": "auth_key2",
                "argValue": "1234567890123456789"
            }, {
                "argName": "ali_auth_delta",
                "argValue": 1800
            }, {
                "argName": "req_auth_ip_white",
                "argValue": "192.168.0.1"
            }, {
                "argName": "req_auth_ip_acl_xfwd",
                "argValue": "all"
            }],
            "functionName": "aliauth"
        }],
        "domainNames": "example.com"
    }

cdn_remote_auth

  • 功能說明:配置遠程鑒權,該功能詳細介紹請參見遠程鑒權

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟遠程鑒權:

    • on:開啟。

    • off:關閉。

    on

    remote_auth_addr

    String

    鑒權伺服器位址。格式:https://cdn.aliyun.com/auth或者http://10.10.10.10/auth

    https://example.aliyundoc.com/auth

    remote_auth_method

    String

    要求方法,支援get/post/head。

    get

    remote_auth_type

    String

    鑒權檔案類型。all表示所有類型,多個檔案類型用豎線分隔、區分大小寫(jpg不等同於JPG)。

    all

    remote_auth_reserve_args

    String

    保留參數設定,多個要求標頭用豎線分隔,不區分大小寫(key等同於KEY)。

    all:保留所有參數。

    ali_delete_all_args:表示刪除所有URL參數。)。

    all

    remote_auth_custom_args

    String

    添加自訂參數,多個參數用豎線分隔、區分大小寫(key不等同於KEY)。

    remote_auth_reserve_header

    String

    保留要求標頭設定,多個要求標頭用豎線分隔,不區分大小寫(http_remote_addr等同於HTTP_Remote_Addr)。

    • all:保留所有要求標頭。

    • ali_delete_all_headers:刪除所有要求標頭。

    all

    remote_auth_custom_header

    String

    添加自訂要求標頭,多個要求標頭用豎線分隔、不區分大小寫(http_remote_addr等同於HTTP_Remote_Addr)。

    remote_auth_success_code

    Integer

    鑒權成功狀態代碼,指鑒權伺服器在鑒權成功之後傳給CDN的鑒權結果。例如:200。支援配置多個狀態代碼,多個狀態代碼之間用英文逗號分隔。

    200

    remote_auth_fail_code

    Integer

    鑒權失敗狀態代碼,指鑒權伺服器在鑒權失敗之後傳給CDN的鑒權結果。例如:403。支援配置多個狀態代碼,多個狀態代碼之間用英文逗號分隔。

    403,404

    remote_auth_other_code_act

    String

    其他狀態代碼是否允許存取,表示在鑒權伺服器返回的狀態代碼既不是鑒權成功狀態代碼,也不是鑒權失敗狀態代碼的情況下,CDN對使用者請求的處理方式,取值:

    • pass:通過(預設值)。

    • reject:拒絕。

    pass

    remote_auth_fail_resp_code

    Integer

    鑒權失敗CDN響應狀態代碼。例如:403,CDN傳給使用者的狀態代碼。

    403

    remote_auth_timeout

    Integer

    鑒權逾時配置,單位ms,最大值為3000。

    500

    remote_auth_timeout_action

    String

    鑒權逾時行為,取值:

    • pass:CDN將直接通過使用者請求。

    • reject:CDN將響應上面配置的“鑒權失敗CDN響應狀態代碼”給使用者。

    pass

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }, {
                "argName": "remote_auth_addr",
                "argValue": "https://example.aliyundoc.com/auth"
            }, {
                "argName": "remote_auth_method",
                "argValue": "get"
            }, {
                "argName": "remote_auth_type",
                "argValue": "all"
            }, {
                "argName": "remote_auth_reserve_args",
                "argValue": "all"
            }, {
                "argName": "remote_auth_custom_args",
                "argValue": ""
            }, {
                "argName": "remote_auth_reserve_header",
                "argValue": "all"
            }, {
                "argName": "remote_auth_custom_header",
                "argValue": ""
            }, {
                "argName": "remote_auth_success_code",
                "argValue": "200"
            }, {
                "argName": "remote_auth_fail_code",
                "argValue": "403"
            }, {
                "argName": "remote_auth_other_code_act",
                "argValue": "pass"
            }, {
                "argName": "remote_auth_fail_resp_code",
                "argValue": "403"
            }, {
                "argName": "remote_auth_timeout",
                "argValue": 500
            }, {
                "argName": "remote_auth_timeout_action",
                "argValue": "pass"
            }],
            "functionName": "cdn_remote_auth"
        }],
        "DomainNames": "example.com"
    }

ip_allow_list_set

  • 功能說明:配置IP白名單,該功能詳細介紹請參見配置IP黑白名單

    說明
    • IP白名單功能與IP黑名單功能(功能函數:ip_black_list_set)存在衝突,只能二選其一進行配置。

    • 如果已經配置了其中一個功能(注意:如果功能函數存在功能開關配置參數,在參數被置為off的情況下,也屬於已存在配置),則必須刪除已經添加的功能配置(您可以通過調用DeleteVodSpecificConfig - 刪除網域名稱配置介面來刪除網域名稱的指定配置),然後才能給另外一個功能添加配置。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    ip_list

    String

    IP列表,多個用半形逗號(,)分隔。

    192.168.0.1/24

    ip_acl_xfwd

    String

    使用X-Forwarded-For要求標頭中的IP,取值範圍:

    • on:預設取值,使用使用者請求中的x-forwarded-for要求標頭(從左向右取第一個IP)作為判斷依據。

    • off:使用真實建連ip作為判斷依據。

    • all:同時使用x-forwarded-for真實建連ip作為判斷依據。

    all

  • 配置樣本:

    {
      "Functions": [
        {
          "functionArgs": [
            {
              "argName": "ip_list",
              "argValue": "192.168.0.1/24"
            },
            {
              "argName": "ip_acl_xfwd",
              "argValue": "all"
            }
          ],
          "functionName": "ip_allow_list_set"
        }
      ],
      "DomainNames": "example.com"
    }

ip_black_list_set

  • 功能說明:配置IP黑名單,該功能詳細介紹請參見配置IP黑白名單

    說明
    • IP黑名單功能與IP白名單功能(功能函數:ip_allow_list_set)存在衝突,只能二選其一進行配置。

    • 如果已經配置了其中一個功能(注意:如果功能函數存在功能開關配置參數,在參數被置為off的情況下,也屬於已存在配置),則必須刪除已經添加的功能配置(您可以通過調用DeleteVodSpecificConfig - 刪除網域名稱配置介面來刪除網域名稱的指定配置),然後才能給另外一個功能添加配置。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    ip_list

    String

    IP列表,多個用半形逗號(,)分隔。

    192.168.0.1

    ip_acl_xfwd

    String

    使用X-Forwarded-For要求標頭中的IP,取值範圍:

    • on:預設取值,使用使用者請求中的x-forwarded-for要求標頭(從左向右取第一個IP)作為判斷依據。

    • off:使用真實建連ip作為判斷依據。

    • all:同時使用x-forwarded-for真實建連ip作為判斷依據。

    all

  • 配置樣本:

    {
      "Functions": [
        {
          "functionArgs": [
            {
              "argName": "ip_list",
              "argValue": "192.168.0.1"
            },
            {
              "argName": "ip_acl_xfwd",
              "argValue": "all"
            }
          ],
          "functionName": "ip_black_list_set"
        }
      ],
      "DomainNames": "example.com"
    }

ali_ua

  • 功能說明:配置User-Agent限制訪問,該功能詳細介紹請參見配置UA黑白名單

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    ua

    String

    填寫User-Agent,支援萬用字元號*(匹配任一字元串)和多個值(多個值用|分割。例如:*curl*|*IE*|*chrome*|*firefox*。)

    *curl*|*IE*|*chrome*|*firefox*

    type

    String

    名單類型,取值:

    • black:黑名單。

    • white:白名單。

    說明

    黑、白名單互斥,同一時間只支援其中一種方式生效。

    black

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "ua",
                "argValue": "*curl*|*IE*|*chrome*|*firefox*"
            }, {
                "argName": "type",
                "argValue": "black"
            }],
            "functionName": "ali_ua"
        }],
        "DomainNames": "example.com"
    }

EdgeScript邊緣指令碼

edge_function

  • 功能說明:邊緣指令碼EdgeScript,該功能詳細介紹請參見EdgeScript概述

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    rule

    String

    DSL規則。

    if eq($uri, '/') {\n rewrite('https://example.com/index.html', 'redirect')\n}

    pri

    Integer

    優先順序,取值:[0,999],數字越小優先順序越高。

    說明

    頭部執行和尾部執行的優先順序互相獨立。

    0

    enable

    String

    本條規則是否生效:

    • on:生效。

    • off:無效。

    on

    name

    String

    規則名稱,僅支援英文字母和底線(_)。

    test

    pos

    String

    規則執行位置,取值:

    • head(預設值):請求處理流程頭部介入。

    • foot:請求處理流程尾部介入。

    head

    brk

    String

    中斷執行,取值:

    • on:命中本條規則後,當前執行位置剩餘規則均跳過。

    • off(預設值):命中本條規則後,還會執行剩餘規則。

    off

    option

    String

    擴充欄位。

    grammar

    String

    規則文法,取值:es2(預設值)和js。

    /

    jsmode

    String

    JS執行模式,取值:

    • redirect:攔截模式。

    • bypass(預設值):旁路模式。

    /

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "name",
                "argValue": "test"
            }, {
                "argName": "rule",
                "argValue": "if eq($uri, '/') {\n  rewrite('https://example.com/index.html', 'redirect')\n}"
            }, {
                "argName": "pri",
                "argValue": "0"
            }, {
                "argName": "pos",
                "argValue": "head"
            }, {
                "argName": "enable",
                "argValue": "on"
            }, {
                "argName": "brk",
                "argValue": "off"
            }, {
                "argName": "option",
                "argValue": ""
            }],
            "functionName": "edge_function"
        }],
        "DomainName": "example.com"
    }

效能最佳化

set_hashkey_args

  • 功能說明:配置忽略URL參數(保留),該功能詳細介紹請參見忽略參數

    說明
    • 忽略URL參數(保留)功能與忽略URL參數(刪除)功能(功能函數:ali_remove_args)存在衝突,只能二選其一進行配置。

    • 如果已經配置了其中一個功能(注意:如果功能函數存在功能開關配置參數,在參數被置為off的情況下,也屬於已存在配置),則必須刪除已經添加的功能配置(您可以通過調用DeleteVodSpecificConfig - 刪除網域名稱配置介面來刪除網域名稱的指定配置),然後才能給另外一個功能添加配置。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    hashkey_args

    String

    保留參數列表,多個用半形逗號(,)分隔,最多支援填寫10個。

    key1,key2

    disable

    String

    是否忽略所有參數:

    • on:忽略所有參數,除了添加參數功能仍能生效以外,刪除參數、僅保留、修改參數功能都將失效。

    • off(預設):關閉忽略參數功能,保留參數、添加參數、刪除參數仍會生效。

    說明

    緩衝hashkey忽略所有參數,優先順序低於保留緩衝參數列表功能。

    on

    keep_oss_args

    String

    是否保留回源參數:

    • on:回源保留所有參數。

    • off:回源攜帶的參數與緩衝hashkey的參數一致。

    on

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "hashkey_args",
                "argValue": ""
            }, {
                "argName": "keep_oss_args",
                "argValue": "on"
            }, {
                "argName": "disable",
                "argValue": "on"
            }],
            "functionName": "set_hashkey_args"
        }],
        "DomainNames": "example.com"
    }

ali_remove_args

  • 功能說明:配置忽略URL參數(刪除),該功能詳細介紹請參見忽略參數

    說明
    • 忽略URL參數(刪除)功能與忽略URL參數(保留)功能(功能函數:set_hashkey_args)存在衝突,只能二選其一進行配置。

    • 如果已經配置了其中一個功能(注意:如果功能函數存在功能開關配置參數,在參數被置為off的情況下,也屬於已存在配置),則必須刪除已經添加的功能配置(您可以通過調用DeleteVodSpecificConfig - 刪除網域名稱配置介面來刪除網域名稱的指定配置),然後才能給另外一個功能添加配置。

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    ali_remove_args

    String

    刪除指定的參數,多個參數之間用空格隔開。

    說明

    剩餘參數將作為hashkey中URL args部分。

    test

    keep_oss_args

    String

    回源是否保留參數:

    • on:回源保留所有參數。

    • off:回源攜帶的參數與緩衝hashkey的參數一致。

    off

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "ali_remove_args",
                "argValue": "test"
            }, {
                "argName": "keep_oss_args",
                "argValue": "off"
            }],
            "functionName": "ali_remove_args"
        }],
        "DomainNames": "example.com"
    }

image_transform

  • 功能說明:配置CDN影像處理,該功能詳細介紹請參見影像處理

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟圖片轉換:

    • on:開啟。

    • off:關閉。

    on

    filetype

    String

    支援轉碼的圖片格式,以豎線分割符號分隔。支援以下參數值:

    • JPEG:JPEG 圖片格式。

    • JPG:JPG 圖片格式。

    • PNG:PNG 圖片格式。

    • WEBP:WEBP 圖片格式。

    • BMP:BMP 圖片格式。

    • GIF:GIF 圖片格式。

    • TIFF:TIFF 圖片格式。

    • JP2:JPEG 2000 圖片格式。

    jpg|jpeg|png

    webp

    String

    是否開啟自適應轉換WEBP:

    • on:開啟。

    • off:關閉。

    on

    orient

    String

    是否開啟圖片自旋轉:

    • on:開啟。

    • off:關閉。

    說明

    只對有自旋轉屬性的圖片生效。

    on

    slim

    Integer

    圖片瘦身,設定瘦身的百分比,可配置範圍是[0,100]。在不改變解析度、尺寸、格式的前提下,縮小圖片品質達到省流目的。

    10

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "filetype",
                "argValue": "jpg|jpeg|png"
            }, {
                "argName": "webp",
                "argValue": "on"
            }, {
                "argName": "orient",
                "argValue": "on"
            }, {
                "argName": "slim",
                "argValue": ""
            }, {
                "argName": "enable",
                "argValue": "on"
            }],
            "functionName": "image_transform"
        }],
        "DomainNames": "example.com"
    }

視頻相關

range

  • 功能說明:配置range回源,該功能詳細介紹請參見配置Range回源

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟range回源:

    • on:開啟。

    • off:關閉。

    • force:強制開啟。

    on

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }],
            "functionName": "range"
        }],
        "DomainNames": "example.com"
    }

video_seek

  • 功能說明:配置視頻拖拽播放,該功能詳細介紹請參見拖拽播放

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟視頻拖拽播放:

    • on:開啟。

    • off:關閉。

    on

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }],
            "functionName": "video_seek"
        }],
        "DomainNames": "example.com"
    }

ali_video_split

  • 功能說明:配置聽視頻,該功能詳細介紹請參見配置聽視頻

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟聽視頻:

    • on:開啟。

    • off:關閉。

    on

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }],
            "functionName": "ali_video_split"
        }],
        "DomainNames": "example.com"
    }

ali_video_preview

  • 功能說明:配置視頻試看,該功能詳細介紹請參見配置音視頻試看

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟視頻試看:

    • on:開啟。

    • off:關閉。

    說明

    支援TS、MP3檔案格式,FLV和MP4使用拖拽功能實現。

    on

    ali_video_preview_argument

    String

    自訂試看參數名,試看參數值的單位必須是秒。

    fds

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }, {
                "argName": "ali_video_preview_argument",
                "argValue": "fds"
            }],
            "functionName": "ali_video_preview"
        }],
        "DomainNames": "example.com"
    }

hls_token_rewrite

  • 功能說明:配置M3U8標準加密改寫,該功能詳細介紹HLS標準加密參數透傳

  • 參數說明:

    參數

    類型

    是否必選

    描述

    樣本值

    enable

    String

    是否開啟M3U8標準加密改寫:

    • on:開啟。

    • off:關閉。

    on

    hls_token_arg_name

    String

    自訂hls token的參數名稱。如果不設定,使用MtsHlsUriToken作為自訂參數名。

    example

  • 配置樣本:

    {
        "Functions": [{
            "functionArgs": [{
                "argName": "enable",
                "argValue": "on"
            }],
            "functionName": "hls_token_rewrite"
        }],
        "DomainNames": "example.com",
    }