Edge Security Acceleration:Feature settings for domain names

Feature description: configures acceleration rules for static and dynamic resources. For more information, see Overview.

Feature ID (FunctionID/FuncId): 46.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "enable",
            "argValue": "on"
        }, {
            "argName": "static_route_type",
            "argValue": ".txt"
        }, {
            "argName": "static_route_url",
            "argValue": "/domain/detail/log.txt"
        },{
            "argName": "static_route_path",
            "argValue": "/abc/test/*"
        }, {
            "argName": "dynamic_route_origin",
            "argValue": "https"
        }, {
            "argName": "dynamic_route_round_robin",
            "argValue": "off"
        }, {
            "argName": "dynamic_route_adapt_cache",
            "argValue": "off"
        }],
        "functionName": "dynamic"
    }],
    "DomainNames": "example.com"
}

Feature description: configures IPv6. For more information, see Enable IPv6.

Feature ID (FunctionID/FuncId): 194.

The following table describes the parameters.

Example:

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

Feature description: configures an origin host. For more information, see Configure an origin host.

Feature ID (FunctionID/FuncId): 18.

The following table describes the parameters.

Example:

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

Feature description: configures the origin protocol policy. For more information, see Configure the static origin protocol policy.

Feature ID (FunctionID/FuncId): 47.

The following table describes the parameters.

Example 1: DCDN redirects requests to the origin server over the protocol that is used by the client. The origin port is the default port of the protocol, which is 80 for HTTP and 443 for HTTPS.

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

Example 2: DCDN redirects requests to the origin server over the protocol that is used by the client. The origin port is a custom port, which is 8080 for HTTP and 4433 for HTTPS.

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

Feature description: configures access control on private Object Storage Service (OSS) buckets. The first time you use this feature, you need to grant DCDN read-only permissions on all OSS buckets in your account. For more information, see Configure access to private OSS buckets.

Feature ID (FunctionID/FuncId): 85.

The following table describes the parameters.

Example:

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

Feature description: configures one or more rules that define the security tokens used to access different private OSS buckets.

Feature ID (FunctionID/FuncId): 183.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "host",
            "argValue": "example.oss-cn-hangzhou.aliyuncs.com"
        },{
            "argName": "key",
            "argValue": "access_id=123 access_secret=123abc"
        }],
        "functionName": "oss_key_list"
    }],
    "DomainNames": "example.com"
}

Feature description: configures Server Name Indication (SNI) for a specified origin server. For more information, see Specify the origin SNI for each origin. Configure SNI

Feature ID (FunctionID/FuncId): 114.

The following table describes the parameters.

Example:

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

Feature description: sets a timeout period for origin requests. For more information, see Configure a timeout period for origin requests.

Feature ID (FunctionID/FuncId): 124.

The following table describes the parameters.

Example:

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

Feature description: configures advanced origin settings. For more information, see Configure advanced origin settings. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature conflicts: The advanced origin feature conflicts with the conditional origin feature (function: origin_dns_host, feature ID: 212). You can use only one of the two features. If you have configured one of the features, you need to delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is set to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 235.

The following table describes the parameters.

Example:

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

Feature description: configures 302 redirection. For more information, see Configure 301/302 redirection. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 219.

The following table describes the parameters.

Example:

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

Feature description: configures a custom origin HTTP header. For more information, see Configure custom HTTP request headers.

Feature ID (FunctionID/FuncId): 39.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "value",
            "argValue": "gzip"
        }, {
            "argName": "key",
            "argValue": "Accept-Encoding"
        }],
        "functionName": "set_req_header"
    }],
    "DomainNames": "example.com"
}

Feature description: configures a custom origin HTTP header (new). For more information, see Configure HTTP request headers (new). This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 228.

The following table describes the parameters.

Example: Add an origin request header to requests that are destined for example.com. Set the header name to Accept-Encoding, and the header value to 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"
}

Feature description: configures an origin HTTP response header. For more information, see Configure HTTP response headers. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 229.

The following table describes the parameters.

Example:

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

Feature description: rewrites origin URIs. For more information, see Rewrite origin URIs. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 225.

The following table describes the parameters.

Example:

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

Feature description: rewrites parameters in origin requests. For more information, see Rewrite URL parameters in origin requests. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 224.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "delete_argument",
            "argValue": ""
        }, {
            "argName": "save_argument",
            "argValue": ""
        }, {
            "argName": "add_argument",
            "argValue": ""
        }, {
            "argName": "modify_argument",
            "argValue": ""
        }, {
            "argName": "ignore_all_argument",
            "argValue": "on"
        }, {
            "argName": "enable",
            "argValue": "on"
        }],
        "functionName": "back_to_origin_argument_rewrite"
    }],
    "DomainNames": "example.com"
}

Feature description: configures Amazon Simple Storage Service (S3) authentication. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 186.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "enabled",
            "argValue": "l2"
        }, {
            "argName": "accesskey",
            "argValue": "123456789"
        }, {
            "argName": "secretkey",
            "argValue": "123456789"
        }, {
            "argName": "region",
            "argValue": "us-east-2"
        }],
        "functionName": "aws_s3_bucket"
    }],
    "DomainNames": "example.com"
}

Feature description: configures an SNI whitelist. For more information, see Configure a common name whitelist. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 223.

The following table describes the parameters.

Example:

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

Feature description: configures a conditional origin. You can use this feature in conjunction with the rules engine feature (function: condition, feature ID: 250) to retrieve content from a specified origin server based on the paths, URL parameters, or headers in user requests. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Prerequisites: At least one rule is created by using the rules engine feature before you configure a conditional origin. When you configure a conditional origin, make sure that a rule is associated with the conditional origin. For more information, see Rules engine. If you do not associate a rule with the conditional origin, all origin traffic is directed to the origin server. This way, conditional origin fetch is not implemented.

Feature conflicts: The conditional origin feature conflicts with the advanced origin feature (function: advanced_origin, feature ID: 235). You can use only one of the two features. If you have configured one of the features, you must delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 212.

The following table describes the parameters.

Example: Set parentid to the value of ConfigId that is generated when you create a rule by using the rules engine feature (function: condition, feature ID: 250) to reference the rule. If a request matches the rule, the request is redirected to the origin server that is specified by the rule.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "ali_origin_dns_host",
            "argValue": "example.com"
        }],
        "functionName": "origin_dns_host",
        "parentId":30119730104****
    }],
    "DomainNames": "example.com"
}

Feature description: configures the origin host for each origin. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 242.

The following table describes the parameters.

Example 1: When a user request is redirected to the origin server example.com, the value of host is host.example.com.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "origin",
            "argValue": "example.com"
        }, {
            "argName": "host",
            "argValue": "host.example.com"
        }],
        "functionName": "origin_host"
    }],
    "DomainNames": "example.com"
}

Example 2: When a user request is redirected to all origin servers, the value of the origin parameter is all, and the value of the host parameter for all origin servers is host.example.com.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "origin",
            "argValue": "all"
        }, {
            "argName": "host",
            "argValue": "host.example.com"
        }],
        "functionName": "origin_host"
    }],
    "DomainNames": "example.com"
}

Example 3: When a user request is redirected to all origin servers, the value of origin is all, and the value of host for all origin servers is ali_follow_origin, which indicates the address of the origin server.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "origin",
            "argValue": "all"
        }, {
            "argName": "host",
            "argValue": "ali_follow_origin"
        }],
        "functionName": "origin_host"
    }],
    "DomainNames": "example.com"
}

Feature description: configures an origin port and protocol. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 276.

The following table describes the parameters.

Example 1: Set the scheme parameter to http and the origin port to 80.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "port",
            "argValue": "80"
        }, {
            "argName": "scheme",
            "argValue": "http"
        }],
        "functionName": "ali_origin_port_scheme"
    }],
    "DomainNames": "example.com"
}

Example 2: Set scheme to follow. When the HTTP protocol is used for origin fetch, requests are sent to port 80 of the origin server. When the HTTPS protocol is used for origin fetch, requests are sent to port 443 of the origin server.

{
"Functions":[{
"functionArgs": [{
"argName": "port",
"argValue": "http:80|https:443"
  }, {
"argName": "scheme",
"argValue": "follow"
  }],
  "functionName":"ali_origin_port_scheme"
}],
  "DomainNames":"example.com"
}

Feature description: configures SNI for a specified origin server. For more information, see Specify the origin SNI for each origin. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 262.

The following table describes the parameters.

Example 1: When a user request is redirected to the origin server origin.example.com, the value of SNI is host.example.com.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "origin",
            "argValue": "origin.example.com"
        }, {
            "argName": "sni_host",
            "argValue": "host.example.com"
        }],
        "functionName": "origin_sni"
    }],
    "DomainNames": "example.com"
}

Example 2: When a user request is redirected to all origin servers, the value of origin is all, and the value of SNI for all origin servers is host.example.com.

{
"Functions": [{
"functionArgs": [{
"argName": "origin",
"argValue": "all"
  }, {
"argName": "sni_host",
"argValue": "host.example.com"
}],
"functionName":"origin_sni"
 }],
 "DomainNames":"example.com"
}

Example 3: When a user request is redirected to all origin servers, the value of origin is all, and the value of SNI for all origin servers is ali_follow_origin, which indicates the address of the origin server.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "origin",
            "argValue": "all"
        }, {
            "argName": "sni_host",
            "argValue": "ali_follow_origin"
        }],
        "functionName": "origin_sni"
    }],
    "DomainNames": "example.com"
}

Example 4: When a user request is redirected to all origin servers, the value of origin is all, and the value of SNI for all origin servers is ali_follow_host, which indicates the address of the origin host.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "origin",
            "argValue": "all"
        }, {
            "argName": "sni_host",
            "argValue": "ali_follow_host"
        }],
        "functionName": "origin_sni"
    }],
    "DomainNames": "example.com"
}

Feature description: configures an origin server group. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 294.

The following table describes the parameters.

Example:

{
"Functions":[{
 "functionArgs":[{
 "argName":"source_group_name",
 "argValue":"test_yidong"
},{
 "argName":"source_info",
  "argValue":"192.168.0.1_10_33_80,192.0.2.1_10_67_80"
},{
"argName":"retry_times",
"argValue":"3"
 },{
"argName":"retry_status_rule",
"argValue":"404,502"
},{
"argName":"failback_source",
  "argValue":"on"
}],
"functionName":"source_group"
}],
 "DomainNames":"example.com"
}

Feature description: configures origin fetch over IPv6. For more information, see Configure origin fetch over IPv6. This feature can only be used after your account is added to the whitelist. To use this feature, submit a ticket.

Feature ID (FunctionID/FuncId): 265.

The following table describes the parameters.

Example:

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

Feature description: configures a time-to-live (TTL) for files. For more information, see Add a cache rule for resources.

Feature ID (FunctionID/FuncId): 6.

The following table describes the parameters.

Example:

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

Feature description: configures a TTL for directories. For more information, see Add a cache rule for resources.

Feature ID (FunctionID/FuncId): 7.

The following table describes the parameters.

Example:

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

Feature description: configures a TTL for HTTP status codes of files. For more information, see Create a cache rule for HTTP status codes.

Feature ID (FunctionID/FuncId): 63.

The following table describes the parameters.

Example:

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

Feature description: configures a TTL for HTTP status codes of directories. For more information, see Create a cache rule for HTTP status codes.

Feature ID (FunctionID/FuncId): 65.

The following table describes the parameters.

Example:

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

Feature description: configures a status code expiration rule that honors the origin.

Feature ID (FunctionID/FuncId): 207.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "default_ttl_code",
            "argValue": "4xx=3,200=3600,5xx=1"
        }],
        "functionName": "default_ttl_code"
    }],
    "DomainNames": "example.com"
}

Feature description: configures a custom HTTP response header. For more information, see Configure an HTTP response header.

Feature ID (FunctionID/FuncId): 27.

The following table describes the parameters.

Example:

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

Feature description: configures a custom error page. For more information, see Create a custom error page.

Feature ID (FunctionID/FuncId): 15.

The following table describes the parameters.

Example:

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

Feature description: configures a URI rewrite rule. For more information, see Create a URI rewrite rule.

Feature ID (FunctionID/FuncId): 43.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "flag",
            "argValue": "redirect"
        }, {
            "argName": "regex",
            "argValue": "^/hello$"
        }, {
            "argName": "replacement",
            "argValue": "/hello/test"
        }, {
            "argName": "rewrite_method",
            "argValue": "302"
        }],
        "functionName": "host_redirect"
    }],
    "DomainNames": "example.com"
}

Feature description: configures custom cache keys. For more information, see Set a custom cache key.

Feature ID (FunctionID/FuncId): 227.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "uri",
            "argValue": [{
                "uri_to_rewrite": "/hello",
                "ai_uri_regex": "/hello/test"
            }]
        }, {
            "argName": "args",
            "argValue": [{
                "args": "test=123",
                "args_operation_type": "add"
            }]
        }, {
            "argName": "headers",
            "argValue": ""
        }, {
            "argName": "variable",
            "argValue": []
        }],
        "functionName": "self_defined_cachekey"
    }],
    "DomainNames": "example.com"
}

Feature description: configures cache sharing.

Feature ID (FunctionID/FuncId): 54.

The following table describes the parameters.

Example:

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

Feature description: configures POPs to serve stale content.

Feature ID (FunctionID/FuncId): 260.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "origin_error_status_code",
            "argValue": "502"
        }, {
            "argName": "extend_expiration_time",
            "argValue": "60"
        }, {
            "argName": "origin_first",
            "argValue": "off"
        }],
        "functionName": "serving_stale_content"
    }],
    "DomainNames": "example.com"
}

Feature description: configures basic HTTPS parameters. For more information, see Configure an SSL certificate, Configure HTTP/2, and Configure OCSP stapling.

Feature ID (FunctionID/FuncId): 78.

The following table describes the parameters.

Example:

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

Feature description: configures force redirect to HTTP. For more information, see Configure force redirect.

Feature conflicts: The redirection to HTTP feature conflicts with the redirection to HTTPS feature (function: https_force, feature ID: 44). You can use only one of the two features. If you have configured one of the features, you must delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 45.

The following table describes the parameters.

Example:

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

Feature description: configures force redirect to HTTPS. For more information, see Configure force redirect.

Feature conflicts: The redirection to HTTPS feature conflicts with the redirection to HTTP feature (function: http_force, feature ID: 45). You can use only one of the two features. If you have configured one of the features, you need to delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is set to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 44.

The following table describes the parameters.

Example:

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

Feature description: configures the TLS protocol version. For more information, see Configure TLS version control.

Feature ID (FunctionID/FuncId): 110.

The following table describes the parameters.

Example:

• TLS 1.0, 1.1, and 1.2 are enabled, and all cipher suites are used. This is the default configuration.

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

• TLS 1.2 and 1.3 are enabled, and the enhanced cipher suite is used.

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

• TLS 1.2 and 1.3 are enabled, and a custom cipher suite is used.

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

Feature description: configures HTTP Strict Transport Security (HSTS). For more information, see Configure HSTS.

Feature ID (FunctionID/FuncId): 112.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "enabled",
            "argValue": "on"
        }, {
            "argName": "https_hsts_max_age",
            "argValue": "5184000"
        }, {
            "argName": "https_hsts_include_subdomains",
            "argValue": "off"
        }],
        "functionName": "HSTS"
    }],
    "DomainNames": "example.com"
}

Feature description: configures a Referer whitelist. For more information, see Configure a Referer whitelist or blacklist to enable hotlink protection.

Feature conflicts: The Referer whitelist feature conflicts with the Referer blacklist feature (function: referer_black_list_set, feature ID: 5). You can use only one of the two features. If you have configured one of the features, you must delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 1.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "allow_empty",
            "argValue": "off"
        }, {
            "argName": "refer_domain_allow_list",
            "argValue": "example.aliyundoc.com,demo.aliyundoc.com"
        }],
        "functionName": "referer_white_list_set"
    }],
    "DomainNames": "example.com"
}

Feature description: configures a Referer blacklist. For more information, see Configure a Referer whitelist or blacklist to enable hotlink protection.

Feature conflicts: The Referer blacklist feature conflicts with the Referer whitelist feature (function: referer_white_list_set, feature ID: 1). You can use only one of the two features. If you have configured one of the features, you need to delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is set to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 5.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "allow_empty",
            "argValue": "off"
        }, {
            "argName": "refer_domain_deny_list",
            "argValue": "example.aliyundoc.com,demo.aliyundoc.com"
        }],
        "functionName": "referer_black_list_set"
    }],
    "DomainNames": "example.com"
}

Feature description: configures URL signing. For more information, see Configure URL signing.

Feature ID (FunctionID/FuncId): 25.

The following table describes the parameters.

Example:

{
    "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"   
        }{
            "argName": "sign_param",
            "argValue": "sign"
        }, {
            "argName": "time_param",
            "argValue": "time",
        }, {
            "argName": "time_format",
            "argValue": "hec"
        }, {
            "argName": "path_encoding",
            "argValue": "on"
        }],
        "functionName": "aliauth"
    }],
    "domainNames": "example.com"
}

Feature description: configures remote authentication.

Feature ID (FunctionID/FuncId): 258.

The following table describes the parameters.

Example:

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

Feature description: configures an IP address whitelist. For more information, see Configure an IP address blacklist or whitelist.

Feature conflicts: The IP address whitelist feature conflicts with the IP address blacklist feature (function: ip_black_list_set, feature ID: 13). You can use only one of the two features. If you have configured one of the features, you need to delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is set to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 69.

The following table describes the parameters.

Example:

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

Feature description: configures an IP address blacklist. For more information, see Configure an IP address blacklist or whitelist.

Feature conflicts: The IP address blacklist feature conflicts with the IP address whitelist feature (function: ip_allow_list_set, feature ID: 69). You can use only one of the two features. If you have configured one of the features, you need to delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is set to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 13.

The following table describes the parameters.

Example:

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

Feature description: configures a User-Agent whitelist or blacklist. For more information, see Configure a User-Agent blacklist or whitelist.

Feature ID (FunctionID/FuncId): 58.

The following table describes the parameters.

Example:

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

Feature description: configures HTML optimization. For more information, see Configure HTML optimization.

Feature ID (FunctionID/FuncId): 16.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "enable",
            "argValue": "on"
        }, {
            "argName": "trim_css",
            "argValue": "off"
        }, {
            "argName": "trim_js",
            "argValue": "off"
        }],
        "functionName": "tesla"
    }],
    "DomainNames": "example.com"
}

Feature description: configures Gzip compression. For more information, see Use the Gzip compression feature.

Feature ID (FunctionID/FuncId): 35.

The following table describes the parameters.

Example:

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

Feature description: configures Brotli compression. For more information, see Configure Brotli compression.

Feature ID (FunctionID/FuncId): 97.

The following table describes the parameters.

Example:

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

Feature description: retains URL parameters. For more information, see Parameter filtering.

Feature conflicts: The URL parameter retaining feature conflicts with the URL parameter deleting feature (function: ali_remove_args, feature ID: 75). You can use only one of the two features. If you have configured one of the features, you need to delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is set to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 19.

The following table describes the parameters.

Example:

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

Feature description: deletes URL parameters. For more information, see Parameter filtering.

Feature conflicts: The URL parameter deleting feature conflicts with the URL parameter retaining feature (function: set_hashkey_args, feature ID: 19). You can use only one of the two features. If you have configured one of the features, you need to delete the configuration of the feature before you configure the other feature. You can call the DeleteDcdnSpecificConfig operation to delete configurations of a domain name. If a feature has a switch parameter and the parameter is set to off, the feature is still considered configured.

Feature ID (FunctionID/FuncId): 75.

The following table describes the parameters.

Example:

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

Feature description: configures image editing. For more information, see Image editing and its benefits.

Feature ID (FunctionID/FuncId): 239.

The following table describes the parameters.

Example:

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

Feature description: configures range origin fetch. For more information, see Configure range origin fetch.

Feature ID (FunctionID/FuncId): 31.

The following table describes the parameters.

Example:

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

Feature description: configures video seeking. For more information, see Configure video seeking.

Feature ID (FunctionID/FuncId): 30.

The following table describes the parameters.

Example:

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

Feature description: configures audio extraction.

Feature ID (FunctionID/FuncId): 204.

The following table describes the parameters.

Example:

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

Feature description: configures video preview.

Feature ID (FunctionID/FuncId): 205.

The following table describes the parameters.

Example:

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

Feature description: configures M3U8 encryption and rewrite.

Feature ID (FunctionID/FuncId): 253.

The following table describes the parameters.

Example:

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

Feature description: configures throttling for individual requests.

Feature ID (FunctionID/FuncId): 72.

Parameter description:

You can specify only the ali_limit_rate parameter or specify parameters carried in the request URL to configure throttling. You can also configure the start and end time for throttling.

You can configure throttling by specifying the traffic_limit_arg and traffic_limit_unit parameters carried in the request URL.

You can configure the start time and end time for throttling by specifying the ali_limit_start_hour and ali_limit_end_hour parameters.

Example 1: Set the throttling rate for individual requests to 1 MB/s.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "ali_limit_rate",
            "argValue": "1m"
        }],
        "functionName": "limit_rate"
    }],
    "DomainNames": "example.com"
}

Example 2: The default throttling rate for individual requests is 1 MB/s. If the request URL contains the rate parameter, the throttling rate is the value of the parameter. For example, the value of the rate parameter is 200, the throttling rate is 200 KB/s.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "ali_limit_rate",
            "argValue": "1m"
        },{
            "argName": "traffic_limit_arg",
            "argValue": "rate"
        },{
            "argName": "traffic_limit_unit",
            "argValue": "k"
        }],
        "functionName": "limit_rate"
    }],
    "DomainNames": "example.com"
}

Feature description: configures WebSocket. For more information, see Configure WebSocket.

Feature ID (FunctionID/FuncId): 144.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "enabled",
            "argValue": "on"
        }, {
            "argName": "origin_scheme",
            "argValue": "http"
        }, {
            "argName": "heartbeat",
            "argValue": "60"
        }],
        "functionName": "websocket"
    }],
    "DomainNames": "example.com"
}

Feature description: configures IP Application Accelerator (IPA). For more information, see What is IP Application Accelerator?

Feature ID (FunctionID/FuncId): 163.

The following table describes the parameters.

Example:

{
    "Functions": [{
        "functionArgs": [{
            "argName": "realip",
            "argValue": "toa"
        }, {
            "argName": "port",
            "argValue": "8443"
        }, {
            "argName": "mux",
            "argValue": "off"
        }],
        "functionName": "protogw"
    }],
    "DomainNames": "example.com"
}

Feature description: configures EdgeScript. For more information, see EdgeScript overview.

Feature ID (FunctionID/FuncId): 180.

The following table describes the parameters.

Example:

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

Feature description: configures EdgeRoutine. For more information, see What is EdgeRoutine?

Feature ID (FunctionID/FuncId): 275.

To use this feature, submit a ticket.

Feature description: configures rules in a graphical user interface. You can configure rules to identify user requests that carry different parameters to determine whether a configuration applies to the requests. This is a more flexible and precise solution for managing policies that you set in DCDN.

Feature ID (FunctionID/FuncId): 250.

The following table describes the parameters.

{\"match\":{\"logic\":\"and\",\"criteria\":[{\"matchType\":\"clientipVer\",\"matchObject\":\"CONNECTING_IP\",\"matchOperator\":\"equals\",\"matchValue\":\"v6\",\"negate\":false}]},\"name\":\"example\",\"status\":\"enable\"}

The following table describes the parameters in argValue.

Example:

The following example shows how to call an API operation to add a rule for the example.com domain name to allow or block requests from clients that use IPv6 addresses.

{
    "Functions": [{
        "functionArgs": [{
            "argName": "rule",
            "argValue": "{\"match\":{\"logic\":\"and\",\"criteria\":[{\"matchType\":\"clientipVer\",\"matchObject\":\"CONNECTING_IP\",\"matchOperator\":\"equals\",\"matchValue\":\"v6\",\"negate\":false}]},\"name\":\"example\",\"status\":\"enable\"}"
        }],
        "functionName": "condition"
    }],
    "DomainNames": "example.com"
}

You can reference existing rules in the configurations of other features to flexibly and precisely control the execution of your configuration policies in DCDN.

Note:

• The parentid parameter is not supported when the feature is condition (rules engine).

• If you want to reference a rule in the configurations of other features, set parentid in the those features to specify a created rule. The parentid is the ConfigId that is generated when you create a rule.

Feature description: configures Quick UDP Internet Connections (QUIC). For more information, see What is the QUIC protocol?

Feature ID (FunctionID/FuncId): 281.

The following table describes the parameters.