| |
| |
| <!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>Cache Group — 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="Cache Group parameters" href="cachegroup_parameter.html"/> |
| <link rel="prev" title="ASN" href="asn.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>Cache Group</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../../../_sources/development/traffic_ops_api/v12/cachegroup.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="cachegroup_parameter.html" class="btn btn-neutral float-right" title="Cache Group parameters">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="asn.html" class="btn btn-neutral" title="ASN"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="cache-group"> |
| <span id="to-api-v12-cachegroup"></span><h1>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="api-1-2-cachegroups"> |
| <span id="to-api-v12-cachegroups-route"></span><h2>/api/1.2/cachegroups<a class="headerlink" href="#api-1-2-cachegroups" title="Permalink to this headline">¶</a></h2> |
| <p><strong>GET /api/1.1/cachegroups</strong></p> |
| <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> |
| <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>string</td> |
| <td>Local unique identifier for the Cache Group</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> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td> |
| <td>string</td> |
| <td>Latitude for the Cache Group</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td> |
| <td>string</td> |
| <td>Longitude for the Cache Group</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td>The name of the Cache Group entry</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td> |
| <td>string</td> |
| <td>Parent cachegroup ID.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td> |
| <td>string</td> |
| <td>Parent cachegroup name.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td> |
| <td>string</td> |
| <td>Secondary parent cachegroup ID.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td> |
| <td>string</td> |
| <td>Secondary parent cachegroup name.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td> |
| <td>string</td> |
| <td>Abbreviation of the Cache Group Name</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> |
| <td>string</td> |
| <td>Unique identifier for the ‘Type’ of Cache Group entry</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> |
| <td>string</td> |
| <td>The name of the type of Cache Group entry</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">"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="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> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>GET /api/1.2/cachegroups/trimmed</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="28%" /> |
| <col width="10%" /> |
| <col width="62%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">name</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">"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> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>GET /api/1.2/cachegroups/:id</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>string</td> |
| <td>Local unique identifier for the Cache Group</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> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td> |
| <td>string</td> |
| <td>Latitude for the Cache Group</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td> |
| <td>string</td> |
| <td>Longitude for the Cache Group</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td>The name of the Cache Group entry</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td> |
| <td>string</td> |
| <td>Parent cachegroup ID.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td> |
| <td>string</td> |
| <td>Parent cachegroup name.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td> |
| <td>string</td> |
| <td>Secondary parent cachegroup ID.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td> |
| <td>string</td> |
| <td>Secondary parent cachegroup name.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td> |
| <td>string</td> |
| <td>Abbreviation of the Cache Group Name</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> |
| <td>string</td> |
| <td>Unique identifier for the ‘Type’ of Cache Group entry</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> |
| <td>string</td> |
| <td>The name of the type of Cache Group entry</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">"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> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <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-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">"1100"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cgw.originUrl"</span><span class="p">,</span> |
| <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"http://to-short.g.foo.net/data/"</span><span class="p">,</span> |
| <span class="s2">"configFile"</span><span class="p">:</span> <span class="s2">"foo.config"</span><span class="p">,</span> |
| <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"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/cachegroups/:id/unassigned_parameters</strong></p> |
| <blockquote> |
| <div><p>Retrieves all parameters NOT assigned to the cache group.</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="35%" /> |
| <col width="20%" /> |
| <col width="45%" /> |
| </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">id</span></code></td> |
| <td>yes</td> |
| <td>Cache group id</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="8%" /> |
| <col width="75%" /> |
| </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">last_updated</span></code></td> |
| <td>string</td> |
| <td>The Time / Date this server entry was last updated</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td> |
| <td>boolean</td> |
| <td>When true, the parameter is accessible only by admin users. Defaults to false.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td> |
| <td>string</td> |
| <td>The parameter value, only visible to admin if secure is true</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td>The parameter name</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">config_file</span></code></td> |
| <td>string</td> |
| <td>The parameter config_file</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">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> |
| <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span> |
| <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> |
| <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span> |
| <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span> |
| <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</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> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="44%" /> |
| <col width="24%" /> |
| <col width="32%" /> |
| </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">parameter_id</span></code></td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="45%" /> |
| <col width="21%" /> |
| <col width="34%" /> |
| </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">cachegroups</span></code></td> |
| <td>array</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>id</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="s2">"cachegroups"</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="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</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="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span> |
| <span class="p">}</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/cachegroupparameters</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="35%" /> |
| <col width="11%" /> |
| <col width="55%" /> |
| </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">cachegroupParameters</span></code></td> |
| <td>array</td> |
| <td>A collection of cache group parameters.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>parameter</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>cachegroup</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="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</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="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="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> |
| <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/cachegroups/:parameter_id/parameter/available</strong></p> |
| <blockquote> |
| <div><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="44%" /> |
| <col width="24%" /> |
| <col width="32%" /> |
| </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">parameter_id</span></code></td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="10%" /> |
| <col width="62%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td> </td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td> </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">"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="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> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>POST /api/1.2/cachegroups</strong></p> |
| <blockquote> |
| <div><p>Create cache group.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</p> |
| <p><strong>Request Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="30%" /> |
| <col width="9%" /> |
| <col width="61%" /> |
| </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">name</span></code></td> |
| <td>yes</td> |
| <td>The name of the Cache Group entry</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td> |
| <td>yes</td> |
| <td>Abbreviation of the Cache Group Name</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td> |
| <td>no</td> |
| <td>Latitude for the Cache Group</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td> |
| <td>no</td> |
| <td>Longitude for the Cache Group</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroup</span></code></td> |
| <td>no</td> |
| <td>Name of Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroup</span></code></td> |
| <td>no</td> |
| <td>Name of Secondary Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> |
| <td>yes</td> |
| <td>The type of Cache Group entry, “EDGE_LOC”, “MID_LOC” or “ORG_LOC”</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">"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">"typeId"</span><span class="p">:</span> <span class="mi">6</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="32%" /> |
| <col width="7%" /> |
| <col width="60%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td>The id of cache group</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td>The name of the Cache Group entry</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td> |
| <td>string</td> |
| <td>Abbreviation of the Cache Group Name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">latitude</span></code></td> |
| <td>string</td> |
| <td>Latitude for the Cache Group</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">longitude</span></code></td> |
| <td>string</td> |
| <td>Longitude for the Cache Group</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroup</span></code></td> |
| <td>string</td> |
| <td>Name of Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td> |
| <td>string</td> |
| <td>id of Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroup</span></code></td> |
| <td>string</td> |
| <td>Name of Secondary Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td> |
| <td>string</td> |
| <td>id of Secondary Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> |
| <td>string</td> |
| <td>The type of Cache Group entry, “EDGE_LOC”, “MID_LOC” or “ORG_LOC”</td> |
| </tr> |
| <tr class="row-even"><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> |
| <tr class="row-odd"><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-even"><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-odd"><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">"Cachegroup successfully created: cache_group_edge"</span> |
| <span class="p">}</span> |
| <span class="p">],</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> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>PUT /api/1.2/cachegroups/{:id}</strong></p> |
| <blockquote> |
| <div><p>Update cache group.</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="12%" /> |
| <col width="19%" /> |
| <col width="69%" /> |
| </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>id</td> |
| <td>yes</td> |
| <td>The id of the cache group to edit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="30%" /> |
| <col width="9%" /> |
| <col width="61%" /> |
| </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">name</span></code></td> |
| <td>yes</td> |
| <td>The name of the Cache Group entry</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td> |
| <td>yes</td> |
| <td>Abbreviation of the Cache Group Name</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td> |
| <td>no</td> |
| <td>Latitude for the Cache Group</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td> |
| <td>no</td> |
| <td>Longitude for the Cache Group</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroup</span></code></td> |
| <td>no</td> |
| <td>Name of Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroup</span></code></td> |
| <td>no</td> |
| <td>Name of Secondary Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> |
| <td>yes</td> |
| <td>The type of Cache Group entry, “EDGE_LOC”, “MID_LOC” or “ORG_LOC”</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">"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> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="32%" /> |
| <col width="7%" /> |
| <col width="60%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td>The id of cache group</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> |
| <td>string</td> |
| <td>The name of the Cache Group entry</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td> |
| <td>string</td> |
| <td>Abbreviation of the Cache Group Name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">latitude</span></code></td> |
| <td>string</td> |
| <td>Latitude for the Cache Group</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">longitude</span></code></td> |
| <td>string</td> |
| <td>Longitude for the Cache Group</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroup</span></code></td> |
| <td>string</td> |
| <td>Name of Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td> |
| <td>string</td> |
| <td>id of Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroup</span></code></td> |
| <td>string</td> |
| <td>Name of Secondary Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td> |
| <td>string</td> |
| <td>id of Secondary Parent Cache Group entry.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> |
| <td>string</td> |
| <td>The type of Cache Group entry, “EDGE_LOC”, “MID_LOC” or “ORG_LOC”</td> |
| </tr> |
| <tr class="row-even"><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> |
| <tr class="row-odd"><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-even"><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-odd"><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">"Cachegroup was updated: cache_group_edge"</span> |
| <span class="p">}</span> |
| <span class="p">],</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> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>DELETE /api/1.2/cachegroups/{:id}</strong></p> |
| <blockquote> |
| <div><p>Delete cache group. The request to delete a cache group, which has servers or child cache group, will be rejected.</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="11%" /> |
| <col width="19%" /> |
| <col width="70%" /> |
| </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>id</td> |
| <td>yes</td> |
| <td>The id of the cache group to delete.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="24%" /> |
| <col width="15%" /> |
| <col width="62%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> |
| <td>array</td> |
| <td>A collection of alert messages.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> |
| <td>string</td> |
| <td>Success, info, warning or error.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> |
| <td>string</td> |
| <td>Alert message.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cachegroup was deleted: cache_group_edge"</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/cachegroups/{:id}/queue_update</strong></p> |
| <blockquote> |
| <div><p>Queue or dequeue updates for all servers assigned to a cache group limited to a specific CDN.</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="35%" /> |
| <col width="20%" /> |
| <col width="45%" /> |
| </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>id</td> |
| <td>yes</td> |
| <td>the cachegroup id.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="20%" /> |
| <col width="13%" /> |
| <col width="67%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>action</td> |
| <td>string</td> |
| <td>queue or dequeue</td> |
| </tr> |
| <tr class="row-odd"><td>cdn</td> |
| <td>string</td> |
| <td>cdn name or cdn ID is required</td> |
| </tr> |
| <tr class="row-even"><td>cdnId</td> |
| <td>string</td> |
| <td>cdn ID or cdn name is required</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="12%" /> |
| <col width="67%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>action</td> |
| <td>string</td> |
| <td>The action processed, queue or dequeue.</td> |
| </tr> |
| <tr class="row-odd"><td>cachegroupId</td> |
| <td>integer</td> |
| <td>cachegroup id</td> |
| </tr> |
| <tr class="row-even"><td>cachegroupName</td> |
| <td>string</td> |
| <td>cachegroup name</td> |
| </tr> |
| <tr class="row-odd"><td>cdn</td> |
| <td>string</td> |
| <td>cdn name</td> |
| </tr> |
| <tr class="row-even"><td>serverNames</td> |
| <td>array</td> |
| <td>servers name array in the cachegroup in cdn</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="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="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> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>POST /api/1.2/cachegroups/{:id}/deliveryservices</strong></p> |
| <blockquote> |
| <div><p>Assign deliveryservices for servers in cachegroup</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="9%" /> |
| <col width="74%" /> |
| </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>id</td> |
| <td>yes</td> |
| <td>The cachegroup id.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="9%" /> |
| <col width="74%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>deliveryServices</td> |
| <td>array</td> |
| <td>The Ids of the delivery services to assign to each server in the cachegroup.</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">"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> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="23%" /> |
| <col width="12%" /> |
| <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>response</td> |
| <td>hash</td> |
| <td>The details of the assignment, if success.</td> |
| </tr> |
| <tr class="row-odd"><td>>id</td> |
| <td>int</td> |
| <td>The cachegroup id.</td> |
| </tr> |
| <tr class="row-even"><td>>serverNames</td> |
| <td>array</td> |
| <td>The server name array in the cachegroup.</td> |
| </tr> |
| <tr class="row-odd"><td>>deliveryServices</td> |
| <td>array</td> |
| <td>The deliveryservice id array.</td> |
| </tr> |
| <tr class="row-even"><td>alerts</td> |
| <td>array</td> |
| <td>A collection of alert messages.</td> |
| </tr> |
| <tr class="row-odd"><td>>level</td> |
| <td>string</td> |
| <td>Success, info, warning or error.</td> |
| </tr> |
| <tr class="row-even"><td>>text</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="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> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="cachegroup_parameter.html" class="btn btn-neutral float-right" title="Cache Group parameters">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="asn.html" class="btn btn-neutral" title="ASN"><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> |