http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html new file mode 100644 index 0000000..fc8cb41 --- /dev/null +++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html @@ -0,0 +1,819 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Delivery Service Regexes — Traffic Control master documentation </title> + + + + + <link rel="shortcut icon" href="../../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> + <link rel="next" title="Delivery Service Statistics" href="deliveryservice_stats.html"/> + <link rel="prev" title="Delivery Service" href="deliveryservice.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</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="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"><a class="reference internal" href="../../traffic_monitor.html">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> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../../index.html">Traffic Control master</a> »</li> + + <li><a href="../../index.html">Developer’s Guide</a> »</li> + + <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Delivery Service Regexes</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../../_sources/development/traffic_ops_api/v12/deliveryservice_regex.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="deliveryservice_stats.html" class="btn btn-neutral float-right" title="Delivery Service Statistics">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="delivery-service-regexes"> +<span id="to-api-v12-ds-regexes"></span><h1>Delivery Service Regexes<a class="headerlink" href="#delivery-service-regexes" title="Permalink to this headline">¶</a></h1> +<p id="to-api-v12-ds-regexes-route"><strong>GET /api/1.2/deliveryservices_regexes</strong></p> +<blockquote> +<div><p>Retrieves regexes for all delivery services.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Oper</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="8%" /> +<col width="74%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsName</span></code></td> +<td>array</td> +<td>Delivery service name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexes</span></code></td> +<td>array</td> +<td>An array of regexes for the delivery service.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>type</span></code></td> +<td>string</td> +<td>The regex type.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>pattern</span></code></td> +<td>string</td> +<td>The regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<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="p">{</span> + <span class="s2">"dsName"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span> + <span class="s2">"regexes"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">"foo.bar.com"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">1</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">},</span> + <span class="p">{</span> <span class="o">...</span> <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.2/deliveryservices/{:dsId}/regexes</strong></p> +<blockquote> +<div><p>Retrieves regexes for a specific delivery service.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="15%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="8%" /> +<col width="74%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>Delivery service regex ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Delivery service regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> +<td>string</td> +<td>Delivery service regex type name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>string</td> +<td>Delivery service regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated for the delivery service.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<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="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">853</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">"foo.bar.com"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">1</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.2/deliveryservices/{:dsId}/regexes/{:id}</strong></p> +<blockquote> +<div><p>Retrieves a regex for a specific delivery service.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="15%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Delivery service regex id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="8%" /> +<col width="74%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>Delivery service regex ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Delivery service regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> +<td>string</td> +<td>Delivery service regex type name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>string</td> +<td>Delivery service regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated for the delivery service.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<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="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.2/deliveryservices/{:dsId}/regexes</strong></p> +<blockquote> +<div><p>Create a regex for a delivery service.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Oper</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="15%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="21%" /> +<col width="14%" /> +<col width="64%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>yes</td> +<td>Regex pattern.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>yes</td> +<td>Regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>yes</td> +<td>Regex type ID.</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<blockquote> +<div><p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="8%" /> +<col width="74%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>Delivery service regex ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Delivery service regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> +<td>string</td> +<td>Delivery service regex type name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>string</td> +<td>Delivery service regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated for the delivery service.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<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="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> + <span class="p">},</span> + <span class="s2">"alerts"</span><span class="p">:[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service regex creation was successful."</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>PUT /api/1.2/deliveryservices/{:dsId}/regexes/{:id}</strong></p> +<blockquote> +<div><p>Update a regex for a delivery service.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Oper</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="15%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Delivery service regex id.</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="21%" /> +<col width="14%" /> +<col width="64%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>yes</td> +<td>Regex pattern.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>yes</td> +<td>Regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>yes</td> +<td>Regex type ID.</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<blockquote> +<div><p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="8%" /> +<col width="74%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>Delivery service regex ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Delivery service regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> +<td>string</td> +<td>Delivery service regex type name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>string</td> +<td>Delivery service regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated for the delivery service.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<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="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> + <span class="p">},</span> + <span class="s2">"alerts"</span><span class="p">:[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service regex update was successful."</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>DELETE /api/1.2/deliveryservices/{:dsId}/regexes/{:id}</strong></p> +<blockquote> +<div><p>Delete delivery service regex.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Oper</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="15%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Delivery service regex id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="24%" /> +<col width="15%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service regex delete was successful."</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="deliveryservice_stats.html" class="btn btn-neutral float-right" title="Delivery Service Statistics">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../../', + VERSION:'master', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html index d9d32b7..2da9cd8 100644 --- a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html +++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html @@ -36,7 +36,7 @@ <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Divisions" href="division.html"/> - <link rel="prev" title="Delivery Service" href="deliveryservice.html"/> + <link rel="prev" title="Delivery Service Regexes" href="deliveryservice_regex.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -180,7 +180,7 @@ <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="deliveryservice_regex.html" class="btn btn-neutral" title="Delivery Service Regexes"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -316,61 +316,61 @@ </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">"source"</span><span class="p">:</span> <span class="s">"TrafficStats"</span><span class="p">,</span> - <span class="s">"summary"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"average"</span><span class="p">:</span> <span class="mf">1081172.785</span><span class="p">,</span> - <span class="s">"count"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span> - <span class="s">"fifthPercentile"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span> - <span class="s">"max"</span><span class="p">:</span> <span class="mf">1326680.31</span><span class="p">,</span> - <span class="s">"min"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span> - <span class="s">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span> - <span class="s">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span> - <span class="s">"totalBytes"</span><span class="p">:</span> <span class="mf">37841047.475</span><span class="p">,</span> - <span class="s">"totalTransactions"</span><span class="p">:</span> <span class="mi">1020202030101</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">"source"</span><span class="p">:</span> <span class="s2">"TrafficStats"</span><span class="p">,</span> + <span class="s2">"summary"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"average"</span><span class="p">:</span> <span class="mf">1081172.785</span><span class="p">,</span> + <span class="s2">"count"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span> + <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span> + <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1326680.31</span><span class="p">,</span> + <span class="s2">"min"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span> + <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span> + <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span> + <span class="s2">"totalBytes"</span><span class="p">:</span> <span class="mf">37841047.475</span><span class="p">,</span> + <span class="s2">"totalTransactions"</span><span class="p">:</span> <span class="mi">1020202030101</span> <span class="p">},</span> - <span class="s">"series"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"columns"</span><span class="p">:</span> <span class="p">[</span> - <span class="s">"time"</span><span class="p">,</span> - <span class="s">""</span> + <span class="s2">"series"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"columns"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"time"</span><span class="p">,</span> + <span class="s2">""</span> <span class="p">],</span> - <span class="s">"count"</span><span class="p">:</span> <span class="mi">60</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"kbps"</span><span class="p">,</span> - <span class="s">"tags"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"total"</span> + <span class="s2">"count"</span><span class="p">:</span> <span class="mi">60</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"kbps"</span><span class="p">,</span> + <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"total"</span> <span class="p">},</span> - <span class="s">"values"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> - <span class="s">"2015-08-11T11:36:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-11T11:36:00Z"</span><span class="p">,</span> <span class="mf">888827.26</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-11T11:37:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-11T11:37:00Z"</span><span class="p">,</span> <span class="mf">980336.563333333</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-11T11:38:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-11T11:38:00Z"</span><span class="p">,</span> <span class="mf">952111.975</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-11T11:39:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-11T11:39:00Z"</span><span class="p">,</span> <span class="n">null</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-11T11:43:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-11T11:43:00Z"</span><span class="p">,</span> <span class="n">null</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-11T11:44:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-11T11:44:00Z"</span><span class="p">,</span> <span class="mf">934682.943333333</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-11T11:45:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-11T11:45:00Z"</span><span class="p">,</span> <span class="mf">1251121.28</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-11T11:46:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-11T11:46:00Z"</span><span class="p">,</span> <span class="mf">1111012.99</span> <span class="p">]</span> <span class="p">]</span> @@ -395,7 +395,7 @@ <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="deliveryservice_regex.html" class="btn btn-neutral" title="Delivery Service Regexes"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops_api/v12/division.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/division.html b/docs/latest/development/traffic_ops_api/v12/division.html index f12753a..e82733c 100644 --- a/docs/latest/development/traffic_ops_api/v12/division.html +++ b/docs/latest/development/traffic_ops_api/v12/division.html @@ -224,20 +224,20 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre>{ - "response": [ - { - "id": "1" - "name": "Central", - "lastUpdated": "2014-10-02 08:22:43" - }, - { - "id": "2" - "name": "West", - "lastUpdated": "2014-10-02 08:22:43" - } - ] -} +<div class="last 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="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Central"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"West"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> </pre></div> </div> </dd> @@ -279,15 +279,15 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre>{ - "response": [ - { - "id": "1" - "name": "Central", - "lastUpdated": "2014-10-02 08:22:43" - } - ] -} +<div class="last 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="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Central"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> </pre></div> </div> </dd> @@ -341,8 +341,8 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"mydivision1"</span> +<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span> <span class="p">}</span> </pre></div> </div> @@ -381,17 +381,17 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Division update was successful."</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Division update was successful."</span> <span class="p">}</span> <span class="p">],</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-03-18 08:57:39"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"mydivision1"</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> @@ -426,8 +426,8 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"mydivision1"</span> +<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span> <span class="p">}</span> </pre></div> </div> @@ -462,10 +462,10 @@ </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">'name'</span><span class="p">:</span> <span class="s">'mydivision1'</span><span class="p">,</span> - <span class="s">'id'</span><span class="p">:</span> <span class="s">'4'</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="s1">'name'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span> + <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'4'</span> <span class="p">}</span> <span class="p">}</span> </pre></div> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops_api/v12/federation.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/federation.html b/docs/latest/development/traffic_ops_api/v12/federation.html index 1d29cad..14c4641 100644 --- a/docs/latest/development/traffic_ops_api/v12/federation.html +++ b/docs/latest/development/traffic_ops_api/v12/federation.html @@ -224,17 +224,17 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>{ - "response": [ - { - "mappings": [ - "cname": "cname-01.", - "ttl": 8865, - ] - "deliveryService": "ds-01", - } - ] -} +<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="p">{</span> + <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"cname-01."</span><span class="p">,</span> + <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">8865</span><span class="p">,</span> + <span class="p">]</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> </pre></div> </div> </div></blockquote> @@ -275,16 +275,16 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"federations"</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">"federations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"ccp-omg-01"</span><span class="p">,</span> - <span class="s">"mappings"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"resolve4"</span><span class="p">:</span> <span class="p">[</span> - <span class="s">"255.255.255.255"</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span> + <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"255.255.255.255"</span> <span class="p">],</span> - <span class="s">"resolve6"</span><span class="p">:</span> <span class="p">[</span> - <span class="s">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span> + <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> @@ -339,16 +339,16 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"federations"</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">"federations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"ccp-omg-01"</span><span class="p">,</span> - <span class="s">"mappings"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"resolve4"</span><span class="p">:</span> <span class="p">[</span> - <span class="s">"255.255.255.255"</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span> + <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"255.255.255.255"</span> <span class="p">],</span> - <span class="s">"resolve6"</span><span class="p">:</span> <span class="p">[</span> - <span class="s">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span> + <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops_api/v12/hwinfo.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/hwinfo.html b/docs/latest/development/traffic_ops_api/v12/hwinfo.html index 6699a61..a87e796 100644 --- a/docs/latest/development/traffic_ops_api/v12/hwinfo.html +++ b/docs/latest/development/traffic_ops_api/v12/hwinfo.html @@ -231,19 +231,19 @@ </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> +<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="p">{</span> - <span class="s">"serverId"</span><span class="p">:</span> <span class="s">"odol-atsmid-cen-09"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-05-27 09:06:02"</span><span class="p">,</span> - <span class="s">"val"</span><span class="p">:</span> <span class="s">"D1S4"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"Physical Disk 0:1:0"</span> + <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span> + <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:0"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"serverId"</span><span class="p">:</span> <span class="s">"odol-atsmid-cen-09"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-05-27 09:06:02"</span><span class="p">,</span> - <span class="s">"val"</span><span class="p">:</span> <span class="s">"D1S4"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"Physical Disk 0:1:1"</span> + <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span> + <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:1"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/development/traffic_ops_api/v12/influxdb.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/influxdb.html b/docs/latest/development/traffic_ops_api/v12/influxdb.html index 4a31ea5..0e5f44b 100644 --- a/docs/latest/development/traffic_ops_api/v12/influxdb.html +++ b/docs/latest/development/traffic_ops_api/v12/influxdb.html @@ -216,28 +216,28 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"aaData"</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">"aaData"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> - <span class="s">"0"</span><span class="p">,</span> - <span class="s">"ALL"</span><span class="p">,</span> - <span class="s">"ALL"</span><span class="p">,</span> - <span class="s">"ALL"</span><span class="p">,</span> - <span class="s">"true"</span><span class="p">,</span> - <span class="s">"ALL"</span><span class="p">,</span> - <span class="s">"142035"</span><span class="p">,</span> - <span class="s">"172365661.85"</span> + <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"true"</span><span class="p">,</span> + <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"142035"</span><span class="p">,</span> + <span class="s2">"172365661.85"</span> <span class="p">],</span> <span class="p">[</span> <span class="mi">1</span><span class="p">,</span> - <span class="s">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span> - <span class="s">"odol-atsec-atl-03"</span><span class="p">,</span> - <span class="s">"us-ga-atlanta"</span><span class="p">,</span> - <span class="s">"1"</span><span class="p">,</span> - <span class="s">"REPORTED"</span><span class="p">,</span> - <span class="s">"596"</span><span class="p">,</span> - <span class="s">"923510.04"</span><span class="p">,</span> - <span class="s">"69.241.82.126"</span> + <span class="s2">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span> + <span class="s2">"odol-atsec-atl-03"</span><span class="p">,</span> + <span class="s2">"us-ga-atlanta"</span><span class="p">,</span> + <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"REPORTED"</span><span class="p">,</span> + <span class="s2">"596"</span><span class="p">,</span> + <span class="s2">"923510.04"</span><span class="p">,</span> + <span class="s2">"69.241.82.126"</span> <span class="p">]</span> <span class="p">],</span> <span class="p">}</span>
