You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2017/01/14 22:06:04 UTC
[74/75] incubator-trafficcontrol-website git commit: add master docs
to latest'
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/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 a6a6b66..c1100dd 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
@@ -25,14 +24,25 @@ Delivery Service
/api/1.2/deliveryservices
+++++++++++++++++++++++++
-**GET /api/1.2/deliveryservices.json**
+**GET /api/1.2/deliveryservices**
- Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+ Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
Authentication Required: Yes
Role(s) Required: None
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``cdn`` | no | Filter delivery services by CDN ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``type`` | no | Filter delivery services by Type ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+
**Response Properties**
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -64,8 +74,6 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``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 |
@@ -107,8 +115,6 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``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. |
@@ -254,12 +260,20 @@ Delivery Service
**GET /api/1.2/deliveryservices/:id**
- Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+ 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>`_.
Authentication Required: Yes
Role(s) Required: None
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
+
**Response Properties**
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -476,13 +490,169 @@ Delivery Service
|
+**GET /api/1.2/deliveryservices/:id/servers**
+
+ Retrieves properties of CDN Edge servers assigned to a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **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 of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "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
+ }
+ ]
+ }
+
+|
+
.. _to-api-v12-ds-health:
Health
++++++
-**GET /api/1.2/deliveryservices/:id/state.json**
+**GET /api/1.2/deliveryservices/:id/state**
Retrieves the failover state for a delivery service.
@@ -531,7 +701,7 @@ Health
|
-**GET /api/1.2/deliveryservices/:id/health.json**
+**GET /api/1.2/deliveryservices/:id/health**
Retrieves the health of all locations (cache groups) for a delivery service.
@@ -581,7 +751,7 @@ Health
|
-**GET /api/1.2/deliveryservices/:id/capacity.json**
+**GET /api/1.2/deliveryservices/:id/capacity**
Retrieves the capacity percentages of a delivery service.
@@ -629,7 +799,7 @@ Health
|
-**GET /api/1.2/deliveryservices/:id/routing.json**
+**GET /api/1.2/deliveryservices/:id/routing**
Retrieves the routing method percentages of a delivery service.
@@ -693,7 +863,7 @@ Health
Server
++++++
-**GET /api/1.2/deliveryserviceserver.json**
+**GET /api/1.2/deliveryserviceserver**
Authentication Required: Yes
@@ -749,7 +919,7 @@ Server
SSL Keys
+++++++++
-**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys.json**
+**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys**
Authentication Required: Yes
@@ -774,29 +944,34 @@ SSL Keys
**Response Properties**
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================================================================================+
- | ``crt`` | string | base64 encoded crt file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``csr`` | string | base64 encoded csr file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``key`` | string | base64 encoded private key file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``version`` | string | The version of the certificate record in Riak |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdn`` | string | The CDN of the delivery service for which the certs were generated. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservice`` | string | The XML ID of the delivery service for which the cert was generated. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname generated by Traffic Ops that is used as the common name when generating the certificate. |
+ | | | This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -807,6 +982,8 @@ SSL Keys
"key": "key",
"csr": "csr"
},
+ "deliveryservice": "my-ds",
+ "cdn": "qa",
"businessUnit": "CDN_Eng",
"city": "Denver",
"organization": "KableTown",
@@ -819,7 +996,7 @@ SSL Keys
|
-**GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys.json**
+**GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys**
Authentication Required: Yes
@@ -844,29 +1021,34 @@ SSL Keys
**Response Properties**
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================================================================================+
- | ``crt`` | string | base64 encoded crt file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``csr`` | string | base64 encoded csr file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``key`` | string | base64 encoded private key file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``version`` | string | The version of the certificate record in Riak |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdn`` | string | The CDN of the delivery service for which the certs were generated. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservice`` | string | The XML ID of the delivery service for which the cert was generated. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname generated by Traffic Ops that is used as the common name when generating the certificate. |
+ | | | This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -877,6 +1059,8 @@ SSL Keys
"key": "key",
"csr": "csr"
},
+ "deliveryservice": "my-ds",
+ "cdn": "qa",
"businessUnit": "CDN_Eng",
"city": "Denver",
"organization": "KableTown",
@@ -889,7 +1073,7 @@ SSL Keys
|
-**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete.json**
+**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete**
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
index 9d6c21f..8d9dadb 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
@@ -27,7 +26,7 @@ Delivery Service Statistics
**GET /api/1.2/deliveryservice_stats.json**
- Retrieves statistics on the delivery services. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+ Retrieves statistics on the delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/division.txt b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
index 2d9403a..e0f1756 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2016 Cisco
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
@@ -22,7 +21,7 @@ Divisions
.. _to-api-v12-division-route:
/api/1.2/divisions
-++++++++++++++++
+++++++++++++++++++
**GET /api/1.2/divisions**
Get all divisions.
@@ -155,6 +154,7 @@ Divisions
"name": "mydivision1"
}
}
+
|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt b/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
index 54038a8..a15922e 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
index 24ce897..2da59c5 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
index b2bdbd5..ca82cf5 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
index 81c00c3..569cb85 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
@@ -115,6 +114,52 @@ Parameter
|
+**GET /api/1.2/parameters/:id/profiles**
+
+ Retrieves all profiles assigned to the parameter.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``id`` | yes | Parameter ID. |
+ +---------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+
**GET /api/1.2/profiles/:id/parameters**
Authentication Required: Yes
@@ -294,31 +339,34 @@ Parameter
+-----------------+---------+--------------------------------------------------------------------------------------+
- **Request Example** ::
+ **Request Example**
- 1. single parameter format exampe:
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":0,
- }
+ 1. single parameter format example: ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0
+ }
+
+ 2. array format example: ::
+
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1
+ }
+ ]
- 2. array format example:
- [
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":0,
- },
- {
- "name":"param2",
- "configFile":"configFile2"
- "value":"value2",
- "secure":1,
- }
- ]
**Response Example** ::
@@ -392,7 +440,7 @@ Parameter
{
"name":"param1",
- "configFile":"configFile1"
+ "configFile":"configFile1",
"value":"value1",
"secure":"0",
}
@@ -444,8 +492,6 @@ Parameter
**Response Example** ::
- Response Example:
-
{
"alerts":
[
@@ -453,7 +499,7 @@ Parameter
"level": "success",
"text": "Parameter was successfully deleted."
}
- ],
+ ]
}
|
@@ -497,8 +543,8 @@ Parameter
{
"name":"param1",
- "configFile":"configFile1"
- "value":"value1",
+ "configFile":"configFile1",
+ "value":"value1"
}
**Response Example** ::
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
index 53c561f..67359e5 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
@@ -30,6 +29,14 @@ Physical Location
Role(s) Required: None
+ **Request Query Parameters**
+
+ +--------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+=============================================+
+ | ``region`` | no | Filter by Region ID. |
+ +--------------+----------+---------------------------------------------+
+
**Response Properties**
+----------------------+--------+------------------------------------------------+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
index 5892272..bec8f9f 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
index bc16128..31b5789 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/region.txt b/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
index 8129854..74e6fbf 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
@@ -30,6 +29,14 @@ Regions
Role(s) Required: None
+ **Request Route Parameters**
+
+ +---------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+=============================================+
+ | ``division`` | no | Filter regions by Division ID. |
+ +---------------+----------+---------------------------------------------+
+
**Response Properties**
+----------------------+--------+------------------------------------------------+
@@ -173,6 +180,7 @@ Regions
"divisionName": "mydivision1"
}
}
+
|
**POST /api/1.2/divisions/:division_name/regions**
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/role.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/role.txt b/docs/latest/_sources/development/traffic_ops_api/v12/role.txt
index 247c0cb..b993c97 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/role.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/role.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/server.txt b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
index 316f126..2a08586 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
@@ -43,7 +42,13 @@ Server
+--------------------+----------+---------------------------------------------+
| ``type`` | no | Used to filter servers by type. |
+--------------------+----------+---------------------------------------------+
- | ``profileId`` | no | Used to filter servers by profile. |
+ | ``profileId`` | no | Used to filter servers by profile ID. |
+ +--------------------+----------+---------------------------------------------+
+ | ``cdn`` | no | Used to filter servers by CDN ID. |
+ +--------------------+----------+---------------------------------------------+
+ | ``cachegroup`` | no | Used to filter servers by cache group ID. |
+ +--------------------+----------+---------------------------------------------+
+ | ``physLocation`` | no | Used to filter servers by phys location ID. |
+--------------------+----------+---------------------------------------------+
**Response Properties**
@@ -340,6 +345,237 @@ Server
|
+**GET /api/1.2/servers/:id/deliveryservices**
+
+ Retrieves all delivery services assigned to the server. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Server ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **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`` | string | 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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 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`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | 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 |
+ | | | 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). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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 |
+ | | | 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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 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. |
+ | | | - 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: |
+ | | | |
+ | | | - 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. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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 | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``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'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+ }
+
+|
+
+
**GET /api/1.2/servers/summary**
Retrieves a count of CDN servers by type.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt b/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt
index 266dad4..0e44cec 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/status.txt b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
index e374527..a97a313 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/system.txt b/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
index e2f5fe7..2740d22 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
index b4b05f8..44c0246 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
index 6c73832..89444f0 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/type.txt b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
index 4238fc7..6d614c5 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
@@ -1,5 +1,4 @@
..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.