You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2017/07/21 16:57:34 UTC
[38/44] incubator-trafficcontrol-website git commit: updates rst docs
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
index c1100dd..ecb17bc 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
@@ -26,7 +26,7 @@ Delivery Service
**GET /api/1.2/deliveryservices**
- Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+ Retrieves all delivery services (if admin or ops) or all delivery services assigned to user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
Authentication Required: Yes
@@ -39,8 +39,12 @@ Delivery Service
+=================+==========+===================================================+
| ``cdn`` | no | Filter delivery services by CDN ID. |
+-----------------+----------+---------------------------------------------------+
+ | ``profile`` | no | Filter delivery services by Profile ID. |
+ +-----------------+----------+---------------------------------------------------+
| ``type`` | no | Filter delivery services by Type ID. |
+-----------------+----------+---------------------------------------------------+
+ | ``logsEnabled`` | no | Filter by logs enabled (true|false). |
+ +-----------------+----------+---------------------------------------------------+
**Response Properties**
@@ -52,9 +56,9 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ | ``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. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -62,21 +66,25 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``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`` | string | The TTL of the DNS bypass response. |
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ | ``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`` | string | - 0: None - no limitations |
+ | ``geoLimit`` | int | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from USA |
| | | |
@@ -85,23 +93,23 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimitCountries`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | string | |
+ | ``geoProvider`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | ``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`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | ``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`` | string | The deliveryservice id (database row number). |
+ | ``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`` | string | |
+ | ``initialDispersion`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -109,31 +117,27 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``logsEnabled`` | bool | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. |
+ | ``longDesc`` | string | Description field. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. |
+ | ``longDesc1`` | string | Description field 1. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc2`` | string | Description field 2. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>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`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | ``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`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ | ``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`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ | ``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` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | 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. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -141,19 +145,19 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The id 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`` | string | - 0: serve with http:// at EDGE |
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
| | | - 1: serve with https:// at EDGE |
| | | - 2: serve with both http:// and https:// at EDGE |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | ``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`` | string | How to treat range requests: |
+ | ``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. |
@@ -168,15 +172,17 @@ Delivery Service
| ``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. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | string | |
+ | ``sslKeyVersion`` | int | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``trRequestHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``trResponseHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ | ``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. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -199,7 +205,7 @@ Delivery Service
"dnsBypassTtl": "30",
"dscp": "40",
"edgeHeaderRewrite": null,
- "exampleURLs": [
+ "exampleURLs": [
"http://edge.foo-ds.foo.bar.net"
],
"geoLimit": "0",
@@ -218,19 +224,11 @@ Delivery Service
"longDesc": "",
"longDesc1": "",
"longDesc2": "",
- "matchList": [
- {
- "pattern": ".*\\.foo-ds\\..*",
- "setNumber": "0",
- "type": "HOST_REGEXP"
- }
- ],
"maxDnsAnswers": "0",
"midHeaderRewrite": null,
- "missLat": "41.881944",
- "missLong": "-87.627778",
+ "missLat": "39.7391500",
+ "missLong": "-104.9847000",
"multiSiteOrigin": false,
- "multiSiteOriginAlgorithm": null,
"orgServerFqdn": "http://baz.boo.net",
"originShield": null,
"profileDescription": "Content Router for over-the-top",
@@ -244,6 +242,8 @@ Delivery Service
"remapText": null,
"signed": false,
"sslKeyVersion": "0",
+ "tenant": "root",
+ "tenantId": 1,
"trRequestHeaders": null,
"trResponseHeaders": "Access-Control-Allow-Origin: *",
"type": "HTTP",
@@ -260,7 +260,7 @@ Delivery Service
**GET /api/1.2/deliveryservices/:id**
- Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+ Retrieves a specific delivery service. If not admin / ops, delivery service must be assigned to user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
Authentication Required: Yes
@@ -283,9 +283,9 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ | ``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. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -293,23 +293,25 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``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`` | string | The TTL of the DNS bypass response. |
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ | ``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. |
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimitRedirectUrl`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations |
+ | ``geoLimit`` | int | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from USA |
| | | |
@@ -318,23 +320,23 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimitCountries`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | string | |
+ | ``geoProvider`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | ``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`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | ``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`` | string | The deliveryservice id (database row number). |
+ | ``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`` | string | |
+ | ``initialDispersion`` | int | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -342,9 +344,9 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``logsEnabled`` | bool | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. |
+ | ``longDesc`` | string | Description field. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. |
+ | ``longDesc1`` | string | Description field 1. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc2`` | string | Description field 2. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -356,19 +358,21 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``>>pattern`` | string | The regexp for the matchList. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | ``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`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ | ``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`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ | ``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` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | 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. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -376,19 +380,19 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The id 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`` | string | - 0: serve with http:// at EDGE |
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
| | | - 1: serve with https:// at EDGE |
| | | - 2: serve with both http:// and https:// at EDGE |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | ``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`` | string | How to treat range requests: |
+ | ``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. |
@@ -403,15 +407,17 @@ Delivery Service
| ``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. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | string | |
+ | ``sslKeyVersion`` | int | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``trRequestHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``trResponseHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ | ``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. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -462,10 +468,9 @@ Delivery Service
],
"maxDnsAnswers": "0",
"midHeaderRewrite": null,
- "missLat": "41.881944",
- "missLong": "-87.627778",
+ "missLat": "39.7391500",
+ "missLong": "-104.9847000",
"multiSiteOrigin": false,
- "multiSiteOriginAlgorithm": null,
"orgServerFqdn": "http://baz.boo.net",
"originShield": null,
"profileDescription": "Content Router for over-the-top",
@@ -479,6 +484,8 @@ Delivery Service
"remapText": null,
"signed": false,
"sslKeyVersion": "0",
+ "tenant": "root",
+ "tenantId": 1,
"trRequestHeaders": null,
"trResponseHeaders": "Access-Control-Allow-Origin: *",
"type": "HTTP",
@@ -492,11 +499,11 @@ Delivery Service
**GET /api/1.2/deliveryservices/:id/servers**
- Retrieves properties of CDN Edge servers assigned to a delivery service.
+ Retrieves properties of CDN EDGE or ORG servers assigned to a delivery service.
Authentication Required: Yes
- Role(s) Required: None
+ Role(s) Required: Admin or Operations or delivery service must be assigned to user.
**Request Route Parameters**
@@ -646,118 +653,430 @@ Delivery Service
|
+**GET /api/1.2/deliveryservices/:id/servers/unassigned**
-.. _to-api-v12-ds-health:
-
-Health
-++++++
-
-**GET /api/1.2/deliveryservices/:id/state**
-
- Retrieves the failover state for a delivery service.
+ Retrieves properties of CDN EDGE or ORG servers not assigned to a delivery service.
Authentication Required: Yes
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+---------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+=================================================+
- | ``failover`` | hash | |
- +------------------+---------+-------------------------------------------------+
- | ``>locations`` | array | |
- +------------------+---------+-------------------------------------------------+
- | ``>destination`` | hash | |
- +------------------+---------+-------------------------------------------------+
- | ``>>location`` | string | |
- +------------------+---------+-------------------------------------------------+
- | ``>>type`` | string | |
- +------------------+---------+-------------------------------------------------+
- | ``>configured`` | boolean | |
- +------------------+---------+-------------------------------------------------+
- | ``>enabled`` | boolean | |
- +------------------+---------+-------------------------------------------------+
- | ``enabled`` | boolean | |
- +------------------+---------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "failover": {
- "locations": [ ],
- "destination": {
- "location": null,
- "type": "DNS",
- },
- "configured": false,
- "enabled": false
- },
- "enabled": true
- }
- }
-
-|
-
-**GET /api/1.2/deliveryservices/:id/health**
-
- Retrieves the health of all locations (cache groups) for a delivery service.
+ Role(s) Required: Admin or Operations or delivery service must be assigned to user
- Authentication Required: Yes
+ **Request Route Parameters**
- Role(s) Required: None
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``totalOnline`` | int | Total number of online caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``cachegroups`` | array | A collection of cache groups. |
- +------------------+--------+-------------------------------------------------+
- | ``>online`` | int | The number of online caches for the cache group |
- +------------------+--------+-------------------------------------------------+
- | ``>offline`` | int | The number of offline caches for the cache |
- | | | group. |
- +------------------+--------+-------------------------------------------------+
- | ``>name`` | string | Cache group name. |
- +------------------+--------+-------------------------------------------------+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
**Response Example** ::
- {
- "response": {
- "totalOnline": 148,
- "totalOffline": 0,
- "cachegroups": [
- {
- "online": 8,
- "offline": 0,
- "name": "us-co-denver"
- },
- {
- "online": 7,
- "offline": 0,
- "name": "us-de-newcastle"
- }
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
]
- }
}
|
-**GET /api/1.2/deliveryservices/:id/capacity**
+**GET /api/1.2/deliveryservices/:id/servers/eligible**
- Retrieves the capacity percentages of a delivery service.
+ Retrieves properties of CDN EDGE or ORG servers not eligible for assignment to a delivery service.
Authentication Required: Yes
- Role(s) Required: None
+ Role(s) Required: Admin or Operations or delivery service must be assigned to user
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type
<TRUNCATED>