http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/api_capability.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/api_capability.html b/docs/latest/development/traffic_ops_api/v12/api_capability.html new file mode 100644 index 0000000..1923323 --- /dev/null +++ b/docs/latest/development/traffic_ops_api/v12/api_capability.html @@ -0,0 +1,764 @@ + + +<!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>API-Capabilities — Traffic Control 2.1-dev 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 2.1-dev documentation" href="../../../index.html"/> + <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> + <link rel="next" title="ASN" href="asn.html"/> + <link rel="prev" title="Users" href="../v11/user.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/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</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_monitor_golang.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"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> +<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_monitor_golang.html">Traffic Monitor Golang</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 2.1-dev</a> »</li> + + <li><a href="../../index.html">Developer’s Guide</a> »</li> + + <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> + + <li>API-Capabilities</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../../_sources/development/traffic_ops_api/v12/api_capability.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../v11/user.html" class="btn btn-neutral" title="Users"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="api-capabilities"> +<span id="to-api-v12-api-capability"></span><h1>API-Capabilities<a class="headerlink" href="#api-capabilities" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-api-capabilities"> +<span id="to-api-v12-api-capability-route"></span><h2>/api/1.2/api_capabilities<a class="headerlink" href="#api-1-2-api-capabilities" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/api_capabilities</strong></p> +<blockquote> +<div><p>Get all API-capability mappings.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="14%" /> +<col width="11%" /> +<col width="51%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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">capability</span></code></td> +<td>no</td> +<td>string</td> +<td>Capability name.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="10%" /> +<col width="65%" /> +</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>int</td> +<td>Mapping id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpMethod</span></code></td> +<td>enum</td> +<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">capability</span></code></td> +<td>string</td> +<td>Capability name.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </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="s2">"6"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/asns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-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">"7"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/asns/*"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</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/api_capabilities/:id</strong></p> +<blockquote> +<div><p>Get an API-capability mapping by id.</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="19%" /> +<col width="15%" /> +<col width="10%" /> +<col width="55%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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>yes</td> +<td>int</td> +<td>Mapping id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="10%" /> +<col width="65%" /> +</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>int</td> +<td>Mapping id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpMethod</span></code></td> +<td>enum</td> +<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">capability</span></code></td> +<td>string</td> +<td>Capability name.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </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="s2">"6"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/asns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</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/api_capabilities</strong></p> +<blockquote> +<div><p>Create an API-capability mapping.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: admin or oper</p> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="19%" /> +<col width="12%" /> +<col width="10%" /> +<col width="60%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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">httpMethod</span></code></td> +<td>yes</td> +<td>enum</td> +<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">route</span></code></td> +<td>yes</td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">capability</span></code></td> +<td>yes</td> +<td>string</td> +<td>Capability name</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">"httpMethod"</span><span class="p">:</span> <span class="s2">"POST"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-write"</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="26%" /> +<col width="10%" /> +<col width="64%" /> +</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">response</span></code></td> +<td>hash</td> +<td>The details of the creation, if success.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>id</span></code></td> +<td>int</td> +<td>Mapping id.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>httpMethod</span></code></td> +<td>enum</td> +<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>capability</span></code></td> +<td>string</td> +<td>Capability name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<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">"response"</span><span class="p">:{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"POST"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-write"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</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">"API-capability mapping was created."</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/api_capabilities/{:id}</strong></p> +<blockquote> +<div><p>Edit an API-capability mapping.</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="25%" /> +<col width="13%" /> +<col width="11%" /> +<col width="51%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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>yes</td> +<td>string</td> +<td>Mapping id.</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="10%" /> +<col width="65%" /> +</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">httpMethod</span></code></td> +<td>enum</td> +<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">capability</span></code></td> +<td>string</td> +<td>Capability name</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">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-read"</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="26%" /> +<col width="10%" /> +<col width="64%" /> +</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">response</span></code></td> +<td>hash</td> +<td>The details of the creation, if success.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>id</span></code></td> +<td>int</td> +<td>Mapping id.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>httpMethod</span></code></td> +<td>enum</td> +<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>capability</span></code></td> +<td>string</td> +<td>Capability name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<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">"response"</span><span class="p">:{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-read"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</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">"API-capability mapping was updated."</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/api_capabilities/{:id}</strong></p> +<blockquote> +<div><p>Delete a capability.</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="25%" /> +<col width="13%" /> +<col width="11%" /> +<col width="51%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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>yes</td> +<td>string</td> +<td>Mapping id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="13%" /> +<col width="64%" /> +</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">"API-capability mapping deleted."</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../v11/user.html" class="btn btn-neutral" title="Users"><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:'2.1-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' + }; + </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/42d25dc5/docs/latest/development/traffic_ops_api/v12/asn.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/asn.html b/docs/latest/development/traffic_ops_api/v12/asn.html index d4f7bfe..034cb5f 100644 --- a/docs/latest/development/traffic_ops_api/v12/asn.html +++ b/docs/latest/development/traffic_ops_api/v12/asn.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>ASN — Traffic Control master documentation </title> + <title>ASN — Traffic Control 2.1-dev documentation </title> @@ -33,10 +33,10 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Cache Group" href="cachegroup.html"/> - <link rel="prev" title="Users" href="../v11/user.html"/> + <link rel="prev" title="API-Capabilities" href="api_capability.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -102,12 +102,15 @@ </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_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</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_monitor_golang.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> @@ -118,10 +121,12 @@ </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"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> <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_monitor_golang.html">Traffic Monitor Golang</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> @@ -159,7 +164,7 @@ <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">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -180,7 +185,7 @@ <a href="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../v11/user.html" class="btn btn-neutral" title="Users"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="api_capability.html" class="btn btn-neutral" title="API-Capabilities"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -251,21 +256,21 @@ </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">"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="p">,</span> - <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</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="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"27"</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">"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="p">,</span> - <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"13"</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="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -336,14 +341,14 @@ </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">"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="p">,</span> - <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"13"</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="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -403,9 +408,9 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"asn"</span><span class="p">:</span> <span class="s">"99"</span><span class="p">,</span> - <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"177"</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span> + <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span> <span class="p">}</span> </pre></div> </div> @@ -454,18 +459,18 @@ </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="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">"99"</span><span class="p">,</span> - <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span><span class="p">,</span> - <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"177"</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="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">"99"</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="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span> <span class="p">},</span> - <span class="s">"alerts"</span><span class="p">:[</span> + <span class="s2">"alerts"</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">"cdn was updated."</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">"cdn was updated."</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -487,7 +492,7 @@ <a href="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../v11/user.html" class="btn btn-neutral" title="Users"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="api_capability.html" class="btn btn-neutral" title="API-Capabilities"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -516,10 +521,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/cache_stats.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/cache_stats.html b/docs/latest/development/traffic_ops_api/v12/cache_stats.html index 9a593ce..94b38b3 100644 --- a/docs/latest/development/traffic_ops_api/v12/cache_stats.html +++ b/docs/latest/development/traffic_ops_api/v12/cache_stats.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Cache Statistics — Traffic Control master documentation </title> + <title>Cache Statistics — Traffic Control 2.1-dev documentation </title> @@ -33,10 +33,10 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> - <link rel="next" title="CDN" href="cdn.html"/> - <link rel="prev" title="Cache Group" href="cachegroup.html"/> + <link rel="next" title="Capabilities" href="capability.html"/> + <link rel="prev" title="Cache Group parameters" href="cachegroup_parameter.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -102,12 +102,15 @@ </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_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</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_monitor_golang.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> @@ -118,10 +121,12 @@ </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"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> <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_monitor_golang.html">Traffic Monitor Golang</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> @@ -159,7 +164,7 @@ <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">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -177,10 +182,10 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="cdn.html" class="btn btn-neutral float-right" title="CDN">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="capability.html" class="btn btn-neutral float-right" title="Capabilities">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="cachegroup.html" class="btn btn-neutral" title="Cache Group"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="cachegroup_parameter.html" class="btn btn-neutral" title="Cache Group parameters"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -304,49 +309,49 @@ </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">"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> +<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">"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">29</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"bandwidth"</span><span class="p">,</span> - <span class="s">"tags"</span><span class="p">:</span> <span class="p">{</span> - <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"over-the-top"</span> + <span class="s2">"count"</span><span class="p">:</span> <span class="mi">29</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bandwidth"</span><span class="p">,</span> + <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"over-the-top"</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-10T22:40:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-10T22:40:00Z"</span><span class="p">,</span> <span class="mi">229340299720</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-10T22:41:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-10T22:41:00Z"</span><span class="p">,</span> <span class="mf">224309221713.334</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-10T22:42:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-10T22:42:00Z"</span><span class="p">,</span> <span class="mf">229551834168.334</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-10T22:43:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-10T22:43:00Z"</span><span class="p">,</span> <span class="mf">225179658876.667</span> <span class="p">],</span> <span class="p">[</span> - <span class="s">"2015-08-10T22:44:00Z"</span><span class="p">,</span> + <span class="s2">"2015-08-10T22:44:00Z"</span><span class="p">,</span> <span class="mi">230443968275</span> <span class="p">]</span> <span class="p">]</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">970410.295</span><span class="p">,</span> - <span class="s">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span> - <span class="s">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span> - <span class="s">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span> - <span class="s">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span> - <span class="s">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</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">970410.295</span><span class="p">,</span> + <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span> + <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span> + <span class="s2">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span> + <span class="s2">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span> + <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> @@ -365,10 +370,10 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="cdn.html" class="btn btn-neutral float-right" title="CDN">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="capability.html" class="btn btn-neutral float-right" title="Capabilities">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="cachegroup.html" class="btn btn-neutral" title="Cache Group"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="cachegroup_parameter.html" class="btn btn-neutral" title="Cache Group parameters"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -397,10 +402,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script>
