http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/basics/cache_revalidation.html ---------------------------------------------------------------------- diff --git a/docs/latest/basics/cache_revalidation.html b/docs/latest/basics/cache_revalidation.html index 7015042..64acbca 100644 --- a/docs/latest/basics/cache_revalidation.html +++ b/docs/latest/basics/cache_revalidation.html @@ -83,7 +83,7 @@ <li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li> <li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Cache Control Headers and Revalidation</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Cache Control Headers and Revalidation</a></li> </ul> </li> </ul> @@ -187,49 +187,49 @@ <div class="section" id="cache-control-headers-and-revalidation"> <span id="index-0"></span><h1>Cache Control Headers and Revalidation<a class="headerlink" href="#cache-control-headers-and-revalidation" title="Permalink to this headline">¶</a></h1> <p>The <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt";>HTTP/1.1 spec</a> allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Cache-Control: max-age=86400 -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 - -<html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">86400</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> <p>In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a <code class="docutils literal"><span class="pre">Expires:</span></code> header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn’t get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache <em>revalidates</em> the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> response, with the new data. If it has not changed, the origin server will send back a <code class="docutils literal"><span class="pre">304</spa n> <span class="pre">Not</span> <span class="pre">Modified</span></code> response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an <code class="docutils literal"><span class="pre">If-Not-Modified-Since:</span></code> header, or an <code class="docutils literal"><span class="pre">If-None-Match:</span></code> header. For example, in the <code class="docutils literal"><span class="pre">If-None-Match:</span></code> case, the origin will send and <code class="docutils literal"><span class="pre">ETag</span></code> header that uniquely identifies the response. The client can use that in an revalidation request like:</p> -<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1 -If-None-Match: "1aa008f-2d-50a3559482cc0" -Host: www.origin.com +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> +<span class="n">If</span><span class="o">-</span><span class="kc">None</span><span class="o">-</span><span class="n">Match</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span> </pre></div> </div> <p>If the content has changed (meaning, the new response would not have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code>, like:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 18 Dec 2014 3:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50aa00feadd" -Cache-Control: max-age=604800 -Content-Length: 49 -Connection: close -Content-Type: text/html; charset=UTF-8 - -<html><body>This is NOT a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50aa00feadd"</span> +<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">49</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">NOT</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> <p>If the Content did not change (meaning, the response would have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code>, like:</p> -<div class="highlight-python"><div class="highlight"><pre>304 Not Modified -Date: Sun, 18 Dec 2014 3:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Cache-Control: max-age=604800 -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">304</span> <span class="n">Not</span> <span class="n">Modified</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> </pre></div> </div> <p>Note that the 304 response only has headers, not the data.</p>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/basics/caching_proxies.html ---------------------------------------------------------------------- diff --git a/docs/latest/basics/caching_proxies.html b/docs/latest/basics/caching_proxies.html index 2e50bca..8390aa0 100644 --- a/docs/latest/basics/caching_proxies.html +++ b/docs/latest/basics/caching_proxies.html @@ -82,7 +82,7 @@ <li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li> <li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Caching Proxies</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Caching Proxies</a></li> <li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li> </ul> </li> @@ -222,16 +222,16 @@ cache is: <code class="docutils literal"><span class="pre">http://www-origin-cac <p class="first admonition-title">Note</p> <p class="last">In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.</p> </div> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 - -<html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> <p>The client is given the URL <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> (note the different hostname) and when attempting to obtain that URL, the following occurs:</p> @@ -241,8 +241,8 @@ Content-Type: text/html; charset=UTF-8 <li><p class="first">Similar to the previous case, the LDNS server resolves the name <code class="docutils literal"><span class="pre">www-origin-cache.cdn.com</span></code> to an IPv4 address, in this example, this address is 55.44.33.22.</p> </li> <li><p class="first">The client opens a TCP connection from a random port locally, to port 80 (the HTTP default) on 55.44.33.22, and sends the following:</p> -<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1 -Host: www-origin-cache.cdn.com +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> +<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">-</span><span class="n">origin</span><span class="o">-</span><span class="n">cache</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span> </pre></div> </div> </li> @@ -255,38 +255,38 @@ Host: www-origin-cache.cdn.com <blockquote> <div><ol class="arabic"> <li><p class="first">The proxy uses DNS to get the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connect to it on port 80, and sends:</p> -<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1 -Host: www.origin.com +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> +<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span> </pre></div> </div> </li> <li><p class="first">The origin server responds with the headers and content as shown:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 - -<html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> </li> <li><p class="first">The proxy sends the origin response on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 -Age: 0 -Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS]) -Server: ATS/4.2.1 - - <html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> +<span class="n">Age</span><span class="p">:</span> <span class="mi">0</span> +<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> + + <span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> </li> @@ -295,18 +295,18 @@ Server: ATS/4.2.1 <p>6b. If it <em>is</em> in the cache:</p> <blockquote> <div><p>The proxy responds to the client with the previously retrieved result:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 -Age: 39711 -Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS]) -Server: ATS/4.2.1 - -<html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> +<span class="n">Age</span><span class="p">:</span> <span class="mi">39711</span> +<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> </div></blockquote> @@ -331,7 +331,7 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote> <li>To retrieve <code class="docutils literal"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> URL, the client connects to 99.88.77.66 on port 8080 and sends:</li> </ol> <blockquote> -<div><div class="highlight-python"><div class="highlight"><pre>GET http://www.origin.com/foo/bar/fun.html HTTP/1.1 +<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> </pre></div> </div> <div class="admonition note"> @@ -346,38 +346,38 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote> <blockquote> <div><ol class="arabic"> <li><p class="first">The proxy uses DNS to obtain the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connects to it on port 80, and sends:</p> -<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1 -Host: www.origin.com +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> +<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span> </pre></div> </div> </li> <li><p class="first">The origin server responds with the headers and content as shown below:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 - -<html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> </li> <li><p class="first">The proxy sends this on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 -Age: 0 -Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS]) -Server: ATS/4.2.1 - -<html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> +<span class="n">Age</span><span class="p">:</span> <span class="mi">0</span> +<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> </li> @@ -386,18 +386,18 @@ Server: ATS/4.2.1 <p>4b. If it <em>is</em> in the cache:</p> <blockquote> <div><p>The proxy responds to the client with the previously retrieved result:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 -Age: 99711 -Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS]) -Server: ATS/4.2.1 - -<html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> +<span class="n">Age</span><span class="p">:</span> <span class="mi">99711</span> +<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> </div></blockquote> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/basics/content_delivery_networks.html ---------------------------------------------------------------------- diff --git a/docs/latest/basics/content_delivery_networks.html b/docs/latest/basics/content_delivery_networks.html index 85685f8..ce84494 100644 --- a/docs/latest/basics/content_delivery_networks.html +++ b/docs/latest/basics/content_delivery_networks.html @@ -80,7 +80,7 @@ <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current"> -<li class="toctree-l2 current"><a class="current reference internal" href="">Content Delivery Networks</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Content Delivery Networks</a></li> <li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li> <li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/basics/http_11.html ---------------------------------------------------------------------- diff --git a/docs/latest/basics/http_11.html b/docs/latest/basics/http_11.html index 36b3776..d2fc1ca 100644 --- a/docs/latest/basics/http_11.html +++ b/docs/latest/basics/http_11.html @@ -81,7 +81,7 @@ <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">HTTP 1.1</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">HTTP 1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li> <li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li> </ul> @@ -201,17 +201,17 @@ </div></blockquote> <ol class="arabic" start="3"> <li><p class="first">The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers):</p> -<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1 -Host: www.origin.com +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> +<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span> </pre></div> </div> </li> <li><p class="first">The server at <code class="docutils literal"><span class="pre">www.origin.com</span></code> looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path <code class="docutils literal"><span class="pre">/foo/bar/fun.html</span></code>, in the example, this is a file that contains <code class="docutils literal"><span class="pre"><html><body>This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">fun</span> <span class="pre">file</body></html></span></code>, so the server responds with the following:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Content-Type: text/html; charset=UTF-8 -Content-Length: 45 +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> -<html><body>This is a fun file</body></html> +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> </li> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/basics/index.html ---------------------------------------------------------------------- diff --git a/docs/latest/basics/index.html b/docs/latest/basics/index.html index d7bb2fc..fafcc40 100644 --- a/docs/latest/basics/index.html +++ b/docs/latest/basics/index.html @@ -78,7 +78,7 @@ <ul class="current"> -<li class="toctree-l1 current"><a class="current reference internal" href="">CDN Basics</a><ul> +<li class="toctree-l1 current"><a class="current reference internal" href="#">CDN Basics</a><ul> <li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li> <li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/index.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/index.html b/docs/latest/development/index.html index 3de6b99..5bbaf65 100644 --- a/docs/latest/development/index.html +++ b/docs/latest/development/index.html @@ -116,7 +116,7 @@ </li> </ul> <ul class="current"> -<li class="toctree-l1 current"><a class="current reference internal" href="">Developer’s Guide</a><ul> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Developer’s Guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_monitor.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_monitor.html b/docs/latest/development/traffic_monitor.html index e3439a5..85d269e 100644 --- a/docs/latest/development/traffic_monitor.html +++ b/docs/latest/development/traffic_monitor.html @@ -121,7 +121,7 @@ <li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li> </ul> @@ -321,7 +321,7 @@ </div> <div class="section" id="api"> <h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2> -<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><em>Traffic Monitor APIs</em></a></p> +<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><span class="std std-ref">Traffic Monitor APIs</span></a></p> <div class="toctree-wrapper compound"> </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops.html b/docs/latest/development/traffic_ops.html index b99bd75..672d71b 100644 --- a/docs/latest/development/traffic_ops.html +++ b/docs/latest/development/traffic_ops.html @@ -118,7 +118,7 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current"> -<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Ops</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li> @@ -207,7 +207,7 @@ </ul> <p>Addionally, the installation of the following RPMs (or equivalent) is required:</p> <ul class="simple"> -<li>All RPMs listed in <a class="reference internal" href="../admin/traffic_ops_install.html#rl-ps"><em>Installing Traffic Ops</em></a></li> +<li>All RPMs listed in <a class="reference internal" href="../admin/traffic_ops_install.html#rl-ps"><span class="std std-ref">Installing Traffic Ops</span></a></li> <li>mysql-test</li> </ul> </div> @@ -269,7 +269,7 @@ <div class="section" id="perl-formatting-conventions"> <h2>Perl Formatting Conventions<a class="headerlink" href="#perl-formatting-conventions" title="Permalink to this headline">¶</a></h2> <p>Perl tidy is for use in code formatting. See the following config file for formatting conventions.</p> -<div class="highlight-python"><div class="highlight"><pre>edit a file called $HOME/.perltidyrc +<div class="highlight-default"><div class="highlight"><pre><span></span>edit a file called $HOME/.perltidyrc -l=156 -et=4 @@ -355,7 +355,7 @@ environment.</td> <li>Install the local dependencies using Carton (cpanfile).</li> </ol> <blockquote> -<div><div class="highlight-python"><div class="highlight"><pre>$ cd traffic_ops/app +<div><div class="highlight-default"><div class="highlight"><pre><span></span>$ cd traffic_ops/app $ carton </pre></div> </div> @@ -365,7 +365,7 @@ $ carton </ol> <blockquote> <div><p>Example:</p> -<div class="highlight-python"><div class="highlight"><pre>master $ mysql +<div class="highlight-default"><div class="highlight"><pre><span></span>master $ mysql Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 305 Server version: 5.6.19 Homebrew @@ -396,7 +396,7 @@ mysql> grant all on to_integration.* to 'to_user'@'localhost' <div class="line"><br /></div> </div> <p>Running the the admin.pl script in setup mode should look like this:</p> -<div class="highlight-python"><div class="highlight"><pre>master $ db/admin.pl --env=development setup +<div class="highlight-default"><div class="highlight"><pre><span></span>master $ db/admin.pl --env=development setup Using database.conf: conf/development/database.conf Using database.conf: conf/development/database.conf Using database.conf: conf/development/database.conf @@ -429,9 +429,9 @@ Warning: Using a password on the command line interface can be insecure. </li> </ol> <blockquote> -<div><div class="highlight-python"><div class="highlight"><pre>[2015-02-24 10:44:34,991] [INFO] Listening at "http://*:3000". +<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">2015</span><span class="o">-</span><span class="mi">02</span><span class="o">-</span><span class="mi">24</span> <span class="mi">10</span><span class="p">:</span><span class="mi">44</span><span class="p">:</span><span class="mi">34</span><span class="p">,</span><span class="mi">991</span><span class="p">]</span> <span class="p">[</span><span class="n">INFO</span><span class="p">]</span> <span class="n">Listening</span> <span class="n">at</span> <span class="s2">"http://*:3000"</span><span class="o">.</span> -Server available at http://127.0.0.1:3000. +<span class="n">Server</span> <span class="n">available</span> <span class="n">at</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="p">:</span><span class="mf">3000.</span> </pre></div> </div> </div></blockquote> @@ -491,14 +491,14 @@ Server available at http://127.0.0.1:3000. </ol> <blockquote> <div>These allow you to add statistic sources for the graph views and APIs.</div></blockquote> -<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops_extensions.html#admin-to-ext-script"><em>Managing Traffic Ops Extensions</em></a>.</p> +<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops_extensions.html#admin-to-ext-script"><span class="std std-ref">Managing Traffic Ops Extensions</span></a>.</p> <div class="section" id="check-extensions"> <h3>Check Extensions<a class="headerlink" href="#check-extensions" title="Permalink to this headline">¶</a></h3> <p>In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the “Health->Server Checks” view and that usually run periodically out of cron.</p> <p>It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.</p> <p>An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops’ <code class="docutils literal"><span class="pre">/api/1.1/servers.json</span></code> REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops <code class="docutils literal"><span class="pre">/api/1.1/servercheck/</span></code> target.</p> <p>A check extension can have a column of <img alt="checkmark" src="../_images/good1.png" />‘s and <img alt="X" src="../_images/bad1.png" />‘s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below:</p> -<div class="highlight-python"><div class="highlight"><pre>Script here. +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Script</span> <span class="n">here</span><span class="o">.</span> </pre></div> </div> <p>Check Extension scripts are located in the $TO_HOME/bin/checks directory.</p> @@ -513,7 +513,7 @@ Server available at http://127.0.0.1:3000. <dt><strong>Maximum Transmission Check - MTU</strong></dt> <dd>Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the <code class="docutils literal"><span class="pre">ip_address</span></code> of the server in the server table.</dd> <dt><strong>Operational Readiness Check - ORT</strong></dt> -<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><em>Configuring Traffic Server</em></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd> +<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd> <dt><strong>Ping Check - 10G, ILO, 10G6, FQDN</strong></dt> <dd><p class="first">The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:</p> <dl class="last docutils"> @@ -546,7 +546,7 @@ Server available at http://127.0.0.1:3000. <div class="section" id="extension-directories"> <h3>Extension Directories<a class="headerlink" href="#extension-directories" title="Permalink to this headline">¶</a></h3> <p>PERL5LIB Example Configuration:</p> -<div class="highlight-python"><div class="highlight"><pre>export PERL5LIB=/opt/traffic_ops_extensions/private/lib/Extensions:/opt/traffic_ops/app/lib/Extensions/TrafficStats +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops_extensions</span><span class="o">/</span><span class="n">private</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="o">/</span><span class="n">TrafficStats</span> </pre></div> </div> </div> @@ -573,9 +573,9 @@ Extensions::YourCustomExtension</p> <div class="section" id="response-structure"> <h3>Response Structure<a class="headerlink" href="#response-structure" title="Permalink to this headline">¶</a></h3> <p>All successful responses have the following structure:</p> -<div class="highlight-python"><div class="highlight"><pre>{ - "response": <JSON object with main response>, -} +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="o"><</span><span class="n">JSON</span> <span class="nb">object</span> <span class="k">with</span> <span class="n">main</span> <span class="n">response</span><span class="o">></span><span class="p">,</span> +<span class="p">}</span> </pre></div> </div> <p>To make the documentation easier to read, only the <code class="docutils literal"><span class="pre"><JSON</span> <span class="pre">object</span> <span class="pre">with</span> <span class="pre">main</span> <span class="pre">response></span></code> is documented, even though the response and version fields are always present.</p> @@ -588,7 +588,7 @@ Extensions::YourCustomExtension</p> <li>Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.</li> </ol> <p>Example:</p> -<div class="highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json +<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json {"alerts":[{"level":"error","text":"Unauthorized, please log in."}]} [jvd@laika ~]$ [jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login @@ -663,7 +663,7 @@ Extensions::YourCustomExtension</p> <dl class="docutils"> <dt>401 Unauthorized</dt> <dd><p class="first">When you don’t supply the right cookie, this is the response.</p> -<div class="last highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json +<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json * Hostname was NOT found in DNS cache * Trying ::1... * connect to ::1 port 3000 failed: Connection refused @@ -695,7 +695,7 @@ Extensions::YourCustomExtension</p> </dd> <dt>404 Not Found</dt> <dd><p class="first">When the resource (path) is non existent Traffic Ops returns a 404:</p> -<div class="last highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json +<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json * Hostname was NOT found in DNS cache * Trying ::1... * connect to ::1 port 3000 failed: Connection refused @@ -729,7 +729,7 @@ Extensions::YourCustomExtension</p> </dd> <dt>500 Internal Server Error</dt> <dd><p class="first">When you are asking for a correct path, but the database doesn’t match, it returns a 500:</p> -<div class="highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json +<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json * Hostname was NOT found in DNS cache * Trying ::1... * connect to ::1 port 3000 failed: Connection refused @@ -807,6 +807,7 @@ Extensions::YourCustomExtension</p> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/cdn.html">CDN</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/changelog.html">Change Logs</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice.html">Delivery Service</a></li> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_regex.html">Delivery Service Regexes</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_stats.html">Delivery Service Statistics</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/division.html">Divisions</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation.html">Federation</a></li> @@ -822,6 +823,7 @@ Extensions::YourCustomExtension</p> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/static_dns.html">Static DNS Entries</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/status.html">Status</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/system.html">System</a></li> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/tenant.html">Tenants</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/to_extension.html">TO Extensions</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/type.html">Types</a></li> <li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/user.html">Users</a></li> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops_api/routes.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/routes.html b/docs/latest/development/traffic_ops_api/routes.html index 398561d..d463b59 100644 --- a/docs/latest/development/traffic_ops_api/routes.html +++ b/docs/latest/development/traffic_ops_api/routes.html @@ -224,16 +224,16 @@ table.docutils col:nth-child(3) { </thead> <tbody valign="top"> <tr class="row-even"><td>/asns</td> -<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><em>/api/1.1/asns</em></a></td> -<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><em>/api/1.2/asns</em></a></td> +<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><span class="std std-ref">/api/1.1/asns</span></a></td> +<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><span class="std std-ref">/api/1.2/asns</span></a></td> </tr> <tr class="row-odd"><td>/availableds</td> -<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><em>/api/1.1/deliveryservices</em></a></td> -<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><em>/api/1.2/deliveryservices</em></a></td> +<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td> +<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td> </tr> <tr class="row-even"><td><em>Not Implemented</em></td> <td><em>Not Implemented</em></td> -<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><em>/api/1.2/cache_stats</em></a></td> +<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><span class="std std-ref">/api/1.2/cache_stats</span></a></td> </tr> <tr class="row-odd"><td>/datacrans</td> <td>/api/1.1/crans.json</td> @@ -244,8 +244,8 @@ table.docutils col:nth-child(3) { <td>/api/1.2/crans.json</td> </tr> <tr class="row-odd"><td>/datadeliveryservice</td> -<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><em>/api/1.1/deliveryservices</em></a></td> -<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><em>/api/1.2/deliveryservices</em></a></td> +<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td> +<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td> </tr> <tr class="row-even"><td>/datadeliveryserviceserver</td> <td>/api/1.1/deliveryserviceserver.json</td> @@ -257,11 +257,11 @@ table.docutils col:nth-child(3) { </tr> <tr class="row-even"><td><em>Not Implemented</em></td> <td><em>Not Implemented</em></td> -<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><em>/api/1.2/deliveryservice_stats</em></a></td> +<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><span class="std std-ref">/api/1.2/deliveryservice_stats</span></a></td> </tr> <tr class="row-odd"><td>/datahwinfo</td> -<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><em>/api/1.1/hwinfo</em></a></td> -<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><em>/api/1.2/hwinfo</em></a></td> +<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><span class="std std-ref">/api/1.1/hwinfo</span></a></td> +<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><span class="std std-ref">/api/1.2/hwinfo</span></a></td> </tr> <tr class="row-even"><td>/datalinks</td> <td>/api/1.1/deliveryserviceserver.json</td> @@ -272,86 +272,86 @@ table.docutils col:nth-child(3) { <td>/api/1.2/deliveryserviceserver.json</td> </tr> <tr class="row-even"><td>/datalogs</td> -<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><em>/api/1.1/logs</em></a></td> -<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><em>/api/1.2/logs</em></a></td> +<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><span class="std std-ref">/api/1.1/logs</span></a></td> +<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><span class="std std-ref">/api/1.2/logs</span></a></td> </tr> <tr class="row-odd"><td>/datalocation/orderby/id</td> -<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><em>/api/1.1/cachegroups</em></a></td> -<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><em>/api/1.2/cachegroups</em></a></td> +<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td> +<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td> </tr> <tr class="row-even"><td>/datalocationparameters</td> -<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><em>/api/1.1/cachegroups</em></a></td> -<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><em>/api/1.2/cachegroups</em></a></td> +<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td> +<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td> </tr> <tr class="row-odd"><td>/dataparameter</td> -<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><em>/api/1.1/parameters</em></a></td> -<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><em>/api/1.2/parameters</em></a></td> +<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><span class="std std-ref">/api/1.1/parameters</span></a></td> +<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><span class="std std-ref">/api/1.2/parameters</span></a></td> </tr> <tr class="row-even"><td>/dataparameter/:parameter</td> <td>/api/1.1/parameters/profile/:parameter.json</td> <td>/api/1.2/parameters/profile/:parameter.json</td> </tr> <tr class="row-odd"><td>/dataphys_location</td> -<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><em>/api/1.1/phys_locations</em></a></td> -<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><em>/api/1.2/phys_locations</em></a></td> +<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><span class="std std-ref">/api/1.1/phys_locations</span></a></td> +<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><span class="std std-ref">/api/1.2/phys_locations</span></a></td> </tr> <tr class="row-even"><td><p class="first">/dataprofile</p> <p class="last">/dataprofile/orderby/name</p> </td> -<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><em>/api/1.1/profiles</em></a></td> -<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><em>/api/1.2/profiles</em></a></td> +<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><span class="std std-ref">/api/1.1/profiles</span></a></td> +<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><span class="std std-ref">/api/1.2/profiles</span></a></td> </tr> <tr class="row-odd"><td>/dataregion</td> -<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><em>/api/1.1/regions</em></a></td> -<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><em>/api/1.2/regions</em></a></td> +<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><span class="std std-ref">/api/1.1/regions</span></a></td> +<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><span class="std std-ref">/api/1.2/regions</span></a></td> </tr> <tr class="row-even"><td>/datarole</td> -<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><em>/api/1.1/roles</em></a></td> -<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><em>/api/1.2/roles</em></a></td> +<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td> +<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td> </tr> <tr class="row-odd"><td>/datarole/orderby/:field</td> -<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><em>/api/1.1/roles</em></a></td> -<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><em>/api/1.2/roles</em></a></td> +<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td> +<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td> </tr> <tr class="row-even"><td>/dataserver</td> -<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><em>/api/1.1/servers</em></a></td> -<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><em>/api/1.2/servers</em></a></td> +<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td> +<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td> </tr> <tr class="row-odd"><td>/dataserver/orderby/:field</td> -<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><em>/api/1.1/servers</em></a></td> -<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><em>/api/1.2/servers</em></a></td> +<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td> +<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td> </tr> <tr class="row-even"><td>/dataserverdetail/select/:hostname</td> <td>/api/1.1/servers/hostname/:hostname/details.json</td> <td>/api/1.2/servers/hostname/:hostname/details.json</td> </tr> <tr class="row-odd"><td>/datastaticdnsentry</td> -<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><em>/api/1.1/staticdnsentries</em></a></td> -<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><em>/api/1.2/staticdnsentries</em></a></td> +<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><span class="std std-ref">/api/1.1/staticdnsentries</span></a></td> +<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><span class="std std-ref">/api/1.2/staticdnsentries</span></a></td> </tr> <tr class="row-even"><td>/datastatus</td> -<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><em>/api/1.1/statuses</em></a></td> -<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><em>/api/1.2/statuses</em></a></td> +<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td> +<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td> </tr> <tr class="row-odd"><td>/datastatus/orderby/name</td> -<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><em>/api/1.1/statuses</em></a></td> -<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><em>/api/1.2/statuses</em></a></td> +<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td> +<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td> </tr> <tr class="row-even"><td>/datatype</td> -<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><em>/api/1.1/types</em></a></td> -<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><em>/api/1.2/types</em></a></td> +<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td> +<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td> </tr> <tr class="row-odd"><td>/datatype/orderby/:field</td> -<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><em>/api/1.1/types</em></a></td> -<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><em>/api/1.2/types</em></a></td> +<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td> +<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td> </tr> <tr class="row-even"><td>/datauser</td> -<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><em>/api/1.1/users</em></a></td> -<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><em>/api/1.2/users</em></a></td> +<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td> +<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td> </tr> <tr class="row-odd"><td>/datauser/orderby/:field</td> -<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><em>/api/1.1/users</em></a></td> -<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><em>/api/1.2/users</em></a></td> +<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td> +<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td> </tr> </tbody> </table> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops_api/v11/asn.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v11/asn.html b/docs/latest/development/traffic_ops_api/v11/asn.html index 8725a5e..f77a422 100644 --- a/docs/latest/development/traffic_ops_api/v11/asn.html +++ b/docs/latest/development/traffic_ops_api/v11/asn.html @@ -231,20 +231,20 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"asns"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"asns"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span> - <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7015"</span><span class="p">,</span> - <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span> - <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span> - <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">},</span>
