域名配置功能函数

调用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协议的回源端口,例如:8080。

    • scheme_origin取值为https时,只需要配置一个HTTPS协议的回源端口,例如:4433。

    • scheme_origin取值为follow时,需要同时配置HTTP协议和HTTPS协议的回源端口,中间用半角冒号(:)分隔,例如:8080:4433。

    8080:4433

  • 配置示例:

    {
        "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时(即执行替换操作),需要设置该参数,取值支持正则表达式。

    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时(即执行替换操作),需要设置该参数,取值支持正则表达式。

    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时(即执行替换操作),需要设置该参数,取值支持正则表达式。

    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

    保留参数设置,all表示保留所有参数,多个参数用竖线分隔、ali_delete_all_args表示删除所有URL参数、区分大小写(key不等同于KEY)。

    all

    remote_auth_custom_args

    String

    添加自定义参数,多个参数用竖线分隔、区分大小写(key不等同于KEY)。

    remote_auth_reserve_header

    String

    保留请求头设置:

    • all:保留所有请求头,多个请求头用竖线分隔。

    • ali_delete_all_headers:删除所有请求头参数、不区分大小写(http_remote_addr等同于HTTP_Remote_Addr)。

    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

    支持转码的图片格式,以竖线分割符号分隔。

    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",
    }