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 2018/05/11 19:24:28 UTC
[incubator-trafficcontrol] branch master updated: Update
traffic_router_api.rst
This is an automated email from the ASF dual-hosted git repository.
neuman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 0d39343 Update traffic_router_api.rst
0d39343 is described below
commit 0d393438b487b2d973ce9c863a285b6fa2912b59
Author: Pavel Pikalov <39...@users.noreply.github.com>
AuthorDate: Fri May 11 14:29:21 2018 -0400
Update traffic_router_api.rst
---
.../development/traffic_router/traffic_router_api.rst | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/docs/source/development/traffic_router/traffic_router_api.rst b/docs/source/development/traffic_router/traffic_router_api.rst
index 2ae902f..f56ca2e 100644
--- a/docs/source/development/traffic_router/traffic_router_api.rst
+++ b/docs/source/development/traffic_router/traffic_router_api.rst
@@ -15,6 +15,7 @@
.. _reference-tr-api:
+
Traffic Router API
==================
@@ -24,7 +25,7 @@ General stats.
|
-**/crs/stats/ip/:ipaddress**
+**/crs/stats/ip/<ipaddress>**
Geolocation information for an IPv4 or IPv6 address.
@@ -42,49 +43,49 @@ A mapping of caches to cache groups and their current health state.
|
-**/crs/locations/:location/caches**
+**/crs/locations/<location>/caches**
A list of caches for this cache group only.
|
-**/crs/consistenthash/cache/coveragezone/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
The resulting cache of the consistent hash using coverage zone file for a given client IP, delivery service, and request path.
|
-**/crs/consistenthash/cache/deep/coveragezone/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/deep/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
The resulting cache of the consistent hash using deep coverage zone file (deep caching) for a given client IP, delivery service, and request path.
|
-**/crs/consistenthash/cache/geolocation/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/geolocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
The resulting cache of the consistent hash using geolocation for a given client IP, delivery service, and request path.
|
-**/crs/consistenthash/deliveryservice/?deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/deliveryservice/?deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
The resulting delivery service of the consistent hash for a given delivery service and request path -- used to test steering delivery services.
|
-**/crs/coveragezone/caches/?deliveryServiceId=:deliveryServiceId&cacheLocationId=:cacheLocationId**
+**/crs/coveragezone/caches/?deliveryServiceId=<deliveryServiceId>&cacheLocationId=<cacheLocationId>**
A list of caches for a given delivery service and cache location.
|
-**/crs/coveragezone/cachelocation/?ip=:ip&deliveryServiceId=:deliveryServiceId**
+**/crs/coveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>**
The resulting cache location for a given client IP and delivery service.
|
-**/crs/deepcoveragezone/cachelocation/?ip=:ip&deliveryServiceId=:deliveryServiceId**
+**/crs/deepcoveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>**
The resulting cache location using deep coverage zone file (deep caching) for a given client IP and delivery service.
--
To stop receiving notification emails like this one, please contact
neuman@apache.org.