You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by el...@apache.org on 2018/05/14 17:22:15 UTC
[incubator-trafficcontrol] 03/12: Updated docs for Anonymous
Blocking
This is an automated email from the ASF dual-hosted git repository.
elsloo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git
commit 4580a80831667c0e4378b28ced60e4a7c59406fd
Author: PeterRyder <pe...@gmail.com>
AuthorDate: Tue Dec 12 17:29:14 2017 -0500
Updated docs for Anonymous Blocking
---
.../admin/quick_howto/anonymous_blocking.rst | 87 +
.../admin/quick_howto/anonymous_blocking01.png | Bin 0 -> 109855 bytes
.../admin/quick_howto/anonymous_blocking02.png | Bin 0 -> 28800 bytes
docs/source/admin/quick_howto/index.rst | 1 +
docs/source/api/v12/deliveryservice.rst | 2141 ++++++++++----------
5 files changed, 1162 insertions(+), 1067 deletions(-)
diff --git a/docs/source/admin/quick_howto/anonymous_blocking.rst b/docs/source/admin/quick_howto/anonymous_blocking.rst
new file mode 100644
index 0000000..4ee0ad5
--- /dev/null
+++ b/docs/source/admin/quick_howto/anonymous_blocking.rst
@@ -0,0 +1,87 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _rl-anonymous_blocking-qht:
+
+**************************************
+Configure Anonymous Blocking
+**************************************
+
+.. Note:: Anonymous Blocking is only supported for HTTP delivery services.
+
+1) Prepare the Anonymous Blocking configuration file
+
+Anonymous Blocking uses a configuration file in JSON format to define blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows::
+
+ {
+
+ "customer": "YourCompany",
+ "version": "1",
+ "date" : "2017-05-23 03:28:25",
+ "name": "Anonymous IP Blocking Policy",
+
+ "anonymousIp": { "blockAnonymousVPN": true,
+ "blockHostingProvider": true,
+ "blockPublicProxy": true,
+ "blockTorExitNode": true},
+
+ "ip4Whitelist": ["192.168.30.0/24", "10.0.2.0/24", "10.1.1.1/32"],
+
+ "ip6Whitelist": ["2001:550:90a::/48", "::1/128"],
+
+ "redirectUrl": "http://youvebeenblocked.com"
+ }
+
+* “anonymousIp” contains the types of IPs which can be checked against the Anonymous IP Database. There are 4 types of IPs which can be checked: VPNs, Hosting Providers, Public Proxies, and Tor Exit Nodes. Each type of IP can be enabled or disabled. If the value is true, IPs which match this type will be blocked when the feature is enabled in the delivery service. If the value is false, IPs which match this type will not be blocked. If an IP matches more than 1 type and any type is enabl [...]
+
+* “redirectUrl” is the URL that will be returned to the blocked clients. Without a redirectUrl, the clients will receive an HTTP response code 403. With a redirectUrl, the clients will be redirected with an HTTP response code 302.
+
+* “ipWhiteList” is an optional element. It includes a list of CIDR (Classless Inter-Domain Routing) blocks indicating the IPv4 and IPv6 subnets that are allowed by the rule. If this list exists and the value is not empty, client IP will be matched against the CIDR list, and if there is any match, the request will be allowed. If there is no match in the white list, further anonymous blocking logic will continue.
+
+
+2) Add Anonymous Blocking parameters on Traffic Ops
+
+The following three new parameters are required to be added into CRConfig.json:
+
+* "anonymousip.policy.configuration": the HTTP URL of the Anonymous Blocking configuration file. Traffic Router will fetch the file from this URL.
+* "anonymousip.polling.url": the HTTP URL of the Anonymous IP Database. Traffic Router will fetch the file from this URL.
+* "anonymousip.polling.interval": the interval that Traffic Router polls the Anonymous Blocking configuration file and Anonymous IP Database.
+
+.. image:: anonymous_blocking01.png
+ :scale: 100%
+ :align: center
+
+3) Enable Anonmyous Blocking for a delivery service
+
+.. image:: anonymous_blocking02.png
+ :scale: 100%
+ :align: center
+
+4) Make configuration effective
+
+Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click "Write CRConfig".
+
+.. image:: regionalgeo03.png
+ :scale: 70%
+ :align: center
+
+5) Traffic Router access log with Anonymous Blocking
+
+Anonymous Blocking extends the field of "rtype" and adds a new field "ANON_BLOCK" in Traffic Router access.log to help to monitor the working of this feature.
+
+If rtype=ANON_BLOCK then the client's IP was found in the Anonymous IP Database and was blocked.
+
+
+
diff --git a/docs/source/admin/quick_howto/anonymous_blocking01.png b/docs/source/admin/quick_howto/anonymous_blocking01.png
new file mode 100644
index 0000000..bda89db
Binary files /dev/null and b/docs/source/admin/quick_howto/anonymous_blocking01.png differ
diff --git a/docs/source/admin/quick_howto/anonymous_blocking02.png b/docs/source/admin/quick_howto/anonymous_blocking02.png
new file mode 100644
index 0000000..0b74046
Binary files /dev/null and b/docs/source/admin/quick_howto/anonymous_blocking02.png differ
diff --git a/docs/source/admin/quick_howto/index.rst b/docs/source/admin/quick_howto/index.rst
index d04a019..4c6b6dc 100644
--- a/docs/source/admin/quick_howto/index.rst
+++ b/docs/source/admin/quick_howto/index.rst
@@ -27,6 +27,7 @@ Traffic Ops
dnssec.rst
federations.rst
regionalgeo.rst
+ anonymous_blocking.rst
steering.rst
Traffic Portal
diff --git a/docs/source/api/v12/deliveryservice.rst b/docs/source/api/v12/deliveryservice.rst
index a79345a..f977fc9 100644
--- a/docs/source/api/v12/deliveryservice.rst
+++ b/docs/source/api/v12/deliveryservice.rst
@@ -51,157 +51,157 @@ Delivery Service
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
- | | | |
- | | | - NEVER (default) |
- | | | - ALWAYS |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassCname`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | int | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
- | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | int | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. 39.7391500 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. -104.9847000 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | int | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | int | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
- | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``tenant`` | string | Owning tenant name |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``tenantId`` | int | Owning tenant ID |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log entries under the "rh=" token. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP responses. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | List of header keys separated by __RETURN__. Listed headers will be included in TR access log entries under the "rh=" token. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -209,6 +209,7 @@ Delivery Service
"response": [
{
"active": true,
+ "anonymousBlockingEnabled": false,
"cacheurl": null,
"ccrDnsTtl": "3600",
"cdnId": "2",
@@ -296,165 +297,165 @@ Delivery Service
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
- | | | |
- | | | - NEVER (default) |
- | | | - ALWAYS |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassCname`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | int | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
- | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | int | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. 39.7391500 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. -104.9847000 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | int | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | int | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
- | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``tenant`` | string | Owning tenant name |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``tenantId`` | int | Owning tenant ID |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log entries under the "rh=" token. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP responses. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -462,6 +463,7 @@ Delivery Service
"response": [
{
"active": true,
+ "anonymousBlockingEnabled": false,
"cacheurl": null,
"ccrDnsTtl": "3600",
"cdnId": "2",
@@ -2075,152 +2077,152 @@ URL Sig Keys
**Request Properties**
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | Parameter | Required | Description |
- +========================+==========+=========================================================================================================+
- | active | yes | true if active, false if inactive. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | cacheurl | no | Cache URL rule to apply to this delivery service. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | cdnId | yes | cdn id |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | checkPath | no | The path portion of the URL to check this deliveryservice for health. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | deepCachingType | no | When to do Deep Caching for this Delivery Service: |
- | | | |
- | | | - NEVER (default) |
- | | | - ALWAYS |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | displayName | yes | Display name |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassCname | no | Bypass CNAME |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassIp6 | no | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassTtl | no | The TTL of the DNS bypass response. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dscp | yes | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoLimit | yes | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from geo limit countries |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoLimitCountries | no | The geo limit countries. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoProvider | yes | - 0: Maxmind(default) |
- | | | - 1: Neustar |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | globalMaxMbps | no | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | globalMaxTps | no | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | fqPacingRate | no | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
- | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | httpBypassFqdn | no | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more |
- | | | than the globalMaxMbps traffic on this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | initialDispersion | yes|no | Initial dispersion. Required for HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | ipv6RoutingEnabled | yes|no | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- | | | Required for DNS*, HTTP* and STEERING* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | logsEnabled | yes | - false: No |
- | | | - true: Yes |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | longDesc | no | Description field. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | longDesc1 | no | Description field 1. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | longDesc2 | no | Description field 2. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | midHeaderRewrite | no | The MID header rewrite actions to perform. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | missLat | yes|no | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | missLong | yes|no | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | multiSiteOrigin | yes|no | true if enabled, false if disabled. Required for DNS* and HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | orgServerFqdn | yes|no | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. This field is |
- | | | required if type is DNS* or HTTP*. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | originShield | no | Origin shield |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | profileId | no | DS profile ID |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | protocol | yes|no | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- | | | |
- | | | Required for DNS*, HTTP* or *STEERING* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | qstringIgnore | yes|no | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- | | | |
- | | | Required for DNS* and HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | rangeRequestHandling | yes|no | How to treat range requests (required for DNS* and HTTP* delivery services): |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
- | | | be a HIT) |
- | | | - 1 Use the background_fetch plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | regionalGeoBlocking | yes | Is the Regional Geo Blocking feature enabled. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | remapText | no | Additional raw remap line text. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | routingName | yes | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | signingAlgorithm | no | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
- | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | sslKeyVersion | no | SSL key version |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | tenantId | No | Owning tenant ID |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trRequestHeaders | no | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log |
- | | | entries under the "rh=" token. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trResponseHeaders | no | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all |
- | | | TR HTTP responses. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | typeId | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | xmlId | yes | Unique string that describes this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +==============================+==========+=========================================================================================================+
+ | active | yes | true if active, false if inactive. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | anonymousBlockingEnabled | no | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cacheurl | no | Cache URL rule to apply to this delivery service. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cdnId | yes | cdn id |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | checkPath | no | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | deepCachingType | no | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | displayName | yes | Display name |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassCname | no | Bypass CNAME |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassIp6 | no | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassTtl | no | The TTL of the DNS bypass response. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dscp | yes | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | fqPacingRate | no | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimit | yes | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from geo limit countries |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitCountries | no | The geo limit countries. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoProvider | yes | - 0: Maxmind(default) |
+ | | | - 1: Neustar |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | globalMaxMbps | no | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | globalMaxTps | no | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | httpBypassFqdn | no | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more |
+ | | | than the globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | initialDispersion | yes|no | Initial dispersion. Required for HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | ipv6RoutingEnabled | yes|no | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ | | | Required for DNS*, HTTP* and STEERING* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | logsEnabled | yes | - false: No |
+ | | | - true: Yes |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc | no | Description field. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc1 | no | Description field 1. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc2 | no | Description field 2. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | midHeaderRewrite | no | The MID header rewrite actions to perform. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | missLat | yes|no | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | missLong | yes|no | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | multiSiteOrigin | yes|no | true if enabled, false if disabled. Required for DNS* and HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | orgServerFqdn | yes|no | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. This field is |
+ | | | required if type is DNS* or HTTP*. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | originShield | no | Origin shield |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | profileId | no | DS profile ID |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | protocol | yes|no | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ | | | |
+ | | | Required for DNS*, HTTP* or *STEERING* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | qstringIgnore | yes|no | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ | | | |
+ | | | Required for DNS* and HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | rangeRequestHandling | yes|no | How to treat range requests (required for DNS* and HTTP* delivery services): |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
+ | | | be a HIT) |
+ | | | - 1 Use the background_fetch plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | regionalGeoBlocking | yes | Is the Regional Geo Blocking feature enabled. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | remapText | no | Additional raw remap line text. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | routingName | yes | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | signingAlgorithm | no | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | sslKeyVersion | no | SSL key version |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | tenantId | No | Owning tenant ID |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | trRequestHeaders | no | Traffic router log request headers |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | trResponseHeaders | no | Traffic router additional response headers |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | typeId | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | xmlId | yes | Unique string that describes this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
**Request Example** ::
@@ -2246,6 +2248,7 @@ URL Sig Keys
"qstringIgnore": 0,
"rangeRequestHandling": 0,
"regionalGeoBlocking": false,
+ "anonymousBlockingEnabled": false,
"signed": false,
"signingAlgorithm": null
}
@@ -2253,161 +2256,161 @@ URL Sig Keys
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
- | | | |
- | | | - NEVER (default) |
- | | | - ALWAYS |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassCname`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | int | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
- | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | int | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. 39.7391500 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. -104.9847000 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | int | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | int | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
- | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log entries under the "rh=" token. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP responses. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -2415,6 +2418,7 @@ URL Sig Keys
"response": [
{
"active": true,
+ "anonymousBlockingEnabled": false,
"cacheurl": null,
"ccrDnsTtl": "3600",
"cdnId": "2",
@@ -2505,152 +2509,152 @@ URL Sig Keys
**Request Properties**
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | Parameter | Required | Description |
- +========================+==========+=========================================================================================================+
- | active | yes | true if active, false if inactive. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | cacheurl | no | Cache URL rule to apply to this delivery service. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | cdnId | yes | cdn id |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | checkPath | no | The path portion of the URL to check this deliveryservice for health. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | deepCachingType | no | When to do Deep Caching for this Delivery Service: |
- | | | |
- | | | - NEVER (default) |
- | | | - ALWAYS |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | displayName | yes | Display name |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassCname | no | Bypass CNAME |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassIp6 | no | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassTtl | no | The TTL of the DNS bypass response. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dscp | yes | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoLimit | yes | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from geo limit countries |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoLimitCountries | no | The geo limit countries. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoProvider | yes | - 0: Maxmind(default) |
- | | | - 1: Neustar |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | globalMaxMbps | no | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | globalMaxTps | no | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | fqPacingRate | no | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
- | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | httpBypassFqdn | no | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more |
- | | | than the globalMaxMbps traffic on this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | initialDispersion | yes|no | Initial dispersion. Required for HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | ipv6RoutingEnabled | yes|no | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- | | | Required for DNS*, HTTP* and STEERING* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | logsEnabled | yes | - false: No |
- | | | - true: Yes |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | longDesc | no | Description field. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | longDesc1 | no | Description field 1. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | longDesc2 | no | Description field 2. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | midHeaderRewrite | no | The MID header rewrite actions to perform. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | missLat | yes|no | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | missLong | yes|no | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | multiSiteOrigin | yes|no | true if enabled, false if disabled. Required for DNS* and HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | orgServerFqdn | yes|no | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. This field is |
- | | | required if type is DNS* or HTTP*. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | originShield | no | Origin shield |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | profileId | no | DS profile ID |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | protocol | yes|no | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- | | | |
- | | | Required for DNS*, HTTP* or *STEERING* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | qstringIgnore | yes|no | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- | | | |
- | | | Required for DNS* and HTTP* delivery services. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | rangeRequestHandling | yes|no | How to treat range requests (required for DNS* and HTTP* delivery services): |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
- | | | be a HIT) |
- | | | - 1 Use the background_fetch plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | regionalGeoBlocking | yes | Is the Regional Geo Blocking feature enabled. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | remapText | no | Additional raw remap line text. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | routingName | yes | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | signingAlgorithm | no | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
- | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | sslKeyVersion | no | SSL key version |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | tenantId | No | Owning tenant ID |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trRequestHeaders | no | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log |
- | | | entries under the "rh=" token. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trResponseHeaders | no | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all |
- | | | TR HTTP responses. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | typeId | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | xmlId | yes | Unique string that describes this deliveryservice. This value cannot be changed on update. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +==========================+==========+=========================================================================================================+
+ | active | yes | true if active, false if inactive. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | anonymousBlockingEnabled | no | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cacheurl | no | Cache URL rule to apply to this delivery service. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cdnId | yes | cdn id |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | checkPath | no | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | deepCachingType | no | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | displayName | yes | Display name |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassCname | no | Bypass CNAME |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassIp6 | no | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassTtl | no | The TTL of the DNS bypass response. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dscp | yes | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | fqPacingRate | no | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimit | yes | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from geo limit countries |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitCountries | no | The geo limit countries. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoProvider | yes | - 0: Maxmind(default) |
+ | | | - 1: Neustar |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | globalMaxMbps | no | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | globalMaxTps | no | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | httpBypassFqdn | no | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more |
+ | | | than the globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | initialDispersion | yes|no | Initial dispersion. Required for HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | ipv6RoutingEnabled | yes|no | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ | | | Required for DNS*, HTTP* and STEERING* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | logsEnabled | yes | - false: No |
+ | | | - true: Yes |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc | no | Description field. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc1 | no | Description field 1. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc2 | no | Description field 2. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | midHeaderRewrite | no | The MID header rewrite actions to perform. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | missLat | yes|no | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | missLong | yes|no | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | multiSiteOrigin | yes|no | true if enabled, false if disabled. Required for DNS* and HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | orgServerFqdn | yes|no | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. This field is |
+ | | | required if type is DNS* or HTTP*. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | originShield | no | Origin shield |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | profileId | no | DS profile ID |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | protocol | yes|no | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ | | | |
+ | | | Required for DNS*, HTTP* or *STEERING* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | qstringIgnore | yes|no | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ | | | |
+ | | | Required for DNS* and HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | rangeRequestHandling | yes|no | How to treat range requests (required for DNS* and HTTP* delivery services): |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
+ | | | be a HIT) |
+ | | | - 1 Use the background_fetch plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | regionalGeoBlocking | yes | Is the Regional Geo Blocking feature enabled. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | remapText | no | Additional raw remap line text. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | routingName | yes | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | signingAlgorithm | no | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | sslKeyVersion | no | SSL key version |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | tenantId | No | Owning tenant ID |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | trRequestHeaders | no | Traffic router log request headers |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | trResponseHeaders | no | Traffic router additional response headers |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | typeId | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | xmlId | yes | Unique string that describes this deliveryservice. This value cannot be changed on update. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
**Request Example** ::
@@ -2676,6 +2680,7 @@ URL Sig Keys
"qstringIgnore": 0,
"rangeRequestHandling": 0,
"regionalGeoBlocking": false,
+ "anonymousBlockingEnabled": false,
"signed": false,
"signingAlgorithm": null
}
@@ -2683,161 +2688,161 @@ URL Sig Keys
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
- | | | |
- | | | - NEVER (default) |
- | | | - ALWAYS |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassCname`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | int | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
- | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | int | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. 39.7391500 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. -104.9847000 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | int | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | int | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
- | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log entries under the "rh=" token. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP responses. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -2845,6 +2850,7 @@ URL Sig Keys
"response": [
{
"active": true,
+ "anonymousBlockingEnabled": false,
"cacheurl": null,
"ccrDnsTtl": "3600",
"cdnId": "2",
@@ -2962,161 +2968,161 @@ URL Sig Keys
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
- | | | |
- | | | - NEVER (default) |
- | | | - ALWAYS |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassCname`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | int | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
- | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | int | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. 39.7391500 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
- | | | |
- | | | - e.g. -104.9847000 or null |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | int | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | int | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
- | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | int | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log entries under the "rh=" token. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP responses. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -3124,6 +3130,7 @@ URL Sig Keys
"response": [
{
"active": true,
+ "anonymousBlockingEnabled": false,
"cacheurl": null,
"ccrDnsTtl": "3600",
"cdnId": "2",
--
To stop receiving notification emails like this one, please contact
elsloo@apache.org.