You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by da...@apache.org on 2017/06/07 23:28:16 UTC
[02/51] [abbrv] [partial] incubator-trafficcontrol-website git
commit: copy 1.8.1 docs to latest
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/9c7fc09d/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..debdf1b 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 1.8.1 documentation </title>
@@ -33,7 +33,10 @@
- <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../../genindex.html"/>
+ <link rel="search" title="Search" href="../../../search.html"/>
+ <link rel="top" title="Traffic Control 1.8.1 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"/>
@@ -58,7 +61,7 @@
- <img src="../../../_static/tc_logo_c_only.png" class="logo" />
+ <img src="../../../_static/tc_logo.png" class="logo" />
</a>
@@ -159,7 +162,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 1.8.1</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -168,7 +171,7 @@
<li>Cache Statistics</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/cache_stats.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/cache_stats.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -304,49 +307,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>
@@ -397,7 +400,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'master',
+ VERSION:'1.8.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/9c7fc09d/docs/latest/development/traffic_ops_api/v12/cachegroup.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/cachegroup.html b/docs/latest/development/traffic_ops_api/v12/cachegroup.html
index b1cbc23..a9eaca7 100644
--- a/docs/latest/development/traffic_ops_api/v12/cachegroup.html
+++ b/docs/latest/development/traffic_ops_api/v12/cachegroup.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Cache Group — Traffic Control master documentation </title>
+ <title>Cache Group — Traffic Control 1.8.1 documentation </title>
@@ -33,7 +33,10 @@
- <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../../genindex.html"/>
+ <link rel="search" title="Search" href="../../../search.html"/>
+ <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Cache Statistics" href="cache_stats.html"/>
<link rel="prev" title="ASN" href="asn.html"/>
@@ -58,7 +61,7 @@
- <img src="../../../_static/tc_logo_c_only.png" class="logo" />
+ <img src="../../../_static/tc_logo.png" class="logo" />
</a>
@@ -159,7 +162,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 1.8.1</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -168,7 +171,7 @@
<li>Cache Group</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/cachegroup.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/cachegroup.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -194,26 +197,6 @@
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
-<p><strong>Request Query Parameters</strong></p>
-<table border="1" class="docutils">
-<colgroup>
-<col width="22%" />
-<col width="13%" />
-<col width="65%" />
-</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">type</span></code></td>
-<td>no</td>
-<td>Filter cache groups by Type ID.</td>
-</tr>
-</tbody>
-</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -279,35 +262,35 @@
</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">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago-1"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -342,16 +325,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "name": "dc-chicago"
- },
- {
- "name": "dc-cmc"
- }
- ],
-}
+<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">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -427,21 +410,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">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -451,70 +434,6 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cachegroups/:id/parameters</strong></p>
-<blockquote>
-<div><p>Authentication Required: Yes</p>
-<p>Role(s) Required: None</p>
-<p><strong>Response Properties</strong></p>
-<table border="1" class="docutils">
-<colgroup>
-<col width="30%" />
-<col width="7%" />
-<col width="63%" />
-</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>Local unique identifier for the parameter</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
-<td>string</td>
-<td>Name of the parameter</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
-<td>string</td>
-<td>Value of the parameter</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">configFile</span></code></td>
-<td>string</td>
-<td>Config file associated with the parameter</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
-<td>bool</td>
-<td>Is the parameter value only visible to admin users</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
-<td>string</td>
-<td>The Time / Date this entry was last updated</td>
-</tr>
-</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="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"1100"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cgw.originUrl"</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">"http://to-short.g.foo.net/data/"</span><span class="p">,</span>
- <span class="s">"configFile"</span><span class="p">:</span> <span class="s">"foo.config"</span><span class="p">,</span>
- <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-08-27 15:11:49"</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/cachegroup/:parameter_id/parameter</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
@@ -568,16 +487,16 @@
</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">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -625,23 +544,23 @@
</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">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"380"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -701,15 +620,15 @@
</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">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -769,13 +688,13 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"cg_edge"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
- <span class="s">"parentCachegroup"</span><span class="p">:</span> <span class="s">"cache_group_mid"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"EDGE_LOC"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -852,25 +771,25 @@
</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">"Cachegroup successfully created: cache_group_edge"</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">"Cachegroup successfully created: cache_group_edge"</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">'longitude'</span> <span class="p">:</span> <span class="s">'45'</span><span class="p">,</span>
- <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 13:55:30'</span><span class="p">,</span>
- <span class="s">'shortName'</span> <span class="p">:</span> <span class="s">'cg_edge'</span><span class="p">,</span>
- <span class="s">'name'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
- <span class="s">'parentCachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_mid'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'12'</span><span class="p">,</span>
- <span class="s">'typeName'</span> <span class="p">:</span> <span class="s">'EDGE_LOC'</span><span class="p">,</span>
- <span class="s">'id'</span> <span class="p">:</span> <span class="s">'104'</span><span class="p">,</span>
- <span class="s">'parentCachegroupId'</span> <span class="p">:</span> <span class="s">'103'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
+ <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -949,13 +868,13 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"cg_edge"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
- <span class="s">"parentCachegroup"</span><span class="p">:</span> <span class="s">"cache_group_mid"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"EDGE_LOC"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1032,25 +951,25 @@
</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">"Cachegroup was updated: cache_group_edge"</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">"Cachegroup was updated: cache_group_edge"</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">'longitude'</span> <span class="p">:</span> <span class="s">'45'</span><span class="p">,</span>
- <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 13:55:30'</span><span class="p">,</span>
- <span class="s">'shortName'</span> <span class="p">:</span> <span class="s">'cg_edge'</span><span class="p">,</span>
- <span class="s">'name'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
- <span class="s">'parentCachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_mid'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'12'</span><span class="p">,</span>
- <span class="s">'typeName'</span> <span class="p">:</span> <span class="s">'EDGE_LOC'</span><span class="p">,</span>
- <span class="s">'id'</span> <span class="p">:</span> <span class="s">'104'</span><span class="p">,</span>
- <span class="s">'parentCachegroupId'</span> <span class="p">:</span> <span class="s">'103'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
+ <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1113,11 +1032,11 @@
</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">"Cachegroup was deleted: cache_group_edge"</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">"Cachegroup was deleted: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1213,18 +1132,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="p">{</span>
- <span class="s">"cachegroupName"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"action"</span><span class="p">:</span> <span class="s">"queue"</span><span class="p">,</span>
- <span class="s">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"atsec-chi-01"</span><span class="p">,</span>
- <span class="s">"atsec-chi-02"</span><span class="p">,</span>
- <span class="s">"atsec-chi-03"</span><span class="p">,</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroupName"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span><span class="p">,</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-01"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-02"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-03"</span><span class="p">,</span>
<span class="p">],</span>
- <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"93"</span><span class="p">,</span>
- <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"cdn_number_1"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"93"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1279,8 +1198,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1329,20 +1248,20 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": {
- "id": 3,
- "serverNames": [ "atlanta-edge-01", "atlanta-edge-07" ],
- "deliveryServices": [ 234, 235 ]
- }
- "alerts":
- [
- {
- "level": "success",
- "text": "Delivery services successfully assigned to all the servers of cache group 3."
- }
- ],
-}
+<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">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"atlanta-edge-01"</span><span class="p">,</span> <span class="s2">"atlanta-edge-07"</span> <span class="p">],</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</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 services successfully assigned to all the servers of cache group 3."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -1390,7 +1309,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'master',
+ VERSION:'1.8.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true