http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/redis.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/redis.html b/docs/1.1.2/development/traffic_ops_rest/redis.html new file mode 100644 index 0000000..059d522 --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/redis.html @@ -0,0 +1,914 @@ + + +<!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>Redis — Traffic Control 1.1.2 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 1.1.2 documentation" href="../../index.html"/> + <link rel="up" title="Traffic Ops" href="../traffic_ops.html"/> + <link rel="next" title="Regions" href="region.html"/> + <link rel="prev" title="Profiles" href="profile.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.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_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_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2 current"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Redis</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/redis.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="profile.html" class="btn btn-neutral" title="Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="redis"> +<span id="to-api-redis"></span><h1>Redis<a class="headerlink" href="#redis" title="Permalink to this headline">¶</a></h1> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The redis documentation needs a thorough review!</p> +</div> +<p><strong>GET /api/1.1/traffic_monitor/stats.json</strong></p> +<p>Authentication Required: Yes</p> +<p>Response Content Type: application/json</p> +<p><strong>Response Messages</strong></p> +<div class="highlight-python"><div class="highlight"><pre>HTTP Status Code: 200 +Reason: Success +</pre></div> +</div> +<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">aaData</span></code></td> +<td>array</td> +<td> </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">"aaData"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">[</span> + <span class="s">"0"</span><span class="p">,</span> + <span class="s">"ALL"</span><span class="p">,</span> + <span class="s">"ALL"</span><span class="p">,</span> + <span class="s">"ALL"</span><span class="p">,</span> + <span class="s">"true"</span><span class="p">,</span> + <span class="s">"ALL"</span><span class="p">,</span> + <span class="s">"142035"</span><span class="p">,</span> + <span class="s">"172365661.85"</span> + <span class="p">],</span> + <span class="p">[</span> + <span class="mi">1</span><span class="p">,</span> + <span class="s">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span> + <span class="s">"odol-atsec-atl-03"</span><span class="p">,</span> + <span class="s">"us-ga-atlanta"</span><span class="p">,</span> + <span class="s">"1"</span><span class="p">,</span> + <span class="s">"REPORTED"</span><span class="p">,</span> + <span class="s">"596"</span><span class="p">,</span> + <span class="s">"923510.04"</span><span class="p">,</span> + <span class="s">"69.241.82.126"</span> + <span class="p">]</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</span> +<span class="p">}</span> +</pre></div> +</div> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.1/redis/stats.json</strong></p> +<p>Authentication Required: Yes</p> +<p>Response Content Type: application/json</p> +<p><strong>Response Messages</strong></p> +<div class="highlight-python"><div class="highlight"><pre>HTTP Status Code: 200 +Reason: Success +</pre></div> +</div> +<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">number</span></code></td> +<td>array</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">what</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">which</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interval</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">elapsed</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">end</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">start</span></code></td> +<td>string</td> +<td> </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">"number"</span><span class="p">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> + <span class="s">"what"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s">"which"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s">"interval"</span><span class="p">:</span> <span class="s">" 10 seconds "</span><span class="p">,</span> + <span class="s">"elapsed"</span><span class="p">:</span> <span class="s">"0.11271 (0.112065) "</span><span class="p">,</span> + <span class="s">"end"</span><span class="p">:</span> <span class="s">"Thu Jan 1 00:00:00 1970"</span><span class="p">,</span> + <span class="s">"start"</span><span class="p">:</span> <span class="s">"Thu Jan 1 00:00:00 1970"</span> +<span class="p">}</span> +</pre></div> +</div> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.1/redis/info/:host_name.json</strong></p> +<p>Authentication Required: Yes</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="33%" /> +<col width="10%" /> +<col width="56%" /> +</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">host_name</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<p>Response Content Type: application/json</p> +<p><strong>Response Messages</strong></p> +<div class="highlight-python"><div class="highlight"><pre>HTTP Status Code: 200 +Reason: Success +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="64%" /> +<col width="14%" /> +<col width="22%" /> +</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">Server</span></code></td> +<td>hash</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>redis_build_id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>config_file</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>uptime_in_seconds</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>hz</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>os</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>redis_git_sha1</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>redis_version</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tcp_port</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>redis_git_dirty</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>redis_mode</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>run_id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>uptime_in_days</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>gcc_version</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>arch_bits</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>lru_clock</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>multiplexing_api</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Keyspace</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>db0</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">slowlog</span></code></td> +<td>array</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">Persistence</span></code></td> +<td>hash</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>rdb_bgsave_in_progress</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>loading</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>rdb_current_bgsave_time_sec</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>aof_enabled</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>rdb_last_bgsave_time_sec</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>aof_last_rewrite_time_sec</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>aof_last_write_status</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>rdb_last_bgsave_status</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>aof_last_bgrewrite_status</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>aof_current_rewrite_time_sec</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>aof_rewrite_scheduled</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>aof_rewrite_in_progress</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>rdb_last_save_time</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>rdb_changes_since_last_save</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">slowlen</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">CPU</span></code></td> +<td>hash</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>used_cpu_user</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>used_cpu_sys</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>used_cpu_user_children</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>used_cpu_sys_children</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Memory</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>used_memory_lua</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>mem_allocator</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>used_memory_human</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>used_memory_peak_human</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>used_memory_peak</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>used_memory_rss</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>mem_fragmentation_ratio</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>used_memory</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">Replication</span></code></td> +<td>hash</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>repl_backlog_first_byte_offset</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>repl_backlog_active</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>repl_backlog_histlen</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>repl_backlog_size</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>role</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>master_repl_offset</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>connected_slaves</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">Clients</span></code></td> +<td>hash</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>client_biggest_input_buf</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>client_longest_output_list</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>blocked_clients</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>connected_clients</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Stats</span></code></td> +<td>hash</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>latest_fork_usec</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>rejected_connections</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>sync_partial_ok</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>pubsub_channels</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>instantaneous_ops_per_sec</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>total_connections_received</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>pubsub_patterns</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>sync_full</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>keyspace_hits</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>keyspace_misses</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>total_commands_processed</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>expired_keys</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>sync_partial_err</span></code></td> +<td>string</td> +<td> </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">"Server"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"redis_build_id"</span><span class="p">:</span> <span class="s">"606641459177bc09"</span><span class="p">,</span> + <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"\/etc\/redis\/redis.conf"</span><span class="p">,</span> + <span class="s">"uptime_in_seconds"</span><span class="p">:</span> <span class="s">"1113787"</span><span class="p">,</span> + <span class="s">"hz"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span> + <span class="s">"os"</span><span class="p">:</span> <span class="s">"Linux 2.6.32-220.el6.x86_64 x86_64"</span><span class="p">,</span> + <span class="s">"redis_git_sha1"</span><span class="p">:</span> <span class="s">"00000000"</span><span class="p">,</span> + <span class="s">"redis_version"</span><span class="p">:</span> <span class="s">"2.8.15"</span><span class="p">,</span> + <span class="s">"process_id"</span><span class="p">:</span> <span class="s">"14607"</span><span class="p">,</span> + <span class="s">"tcp_port"</span><span class="p">:</span> <span class="s">"6379"</span><span class="p">,</span> + <span class="s">"redis_git_dirty"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"redis_mode"</span><span class="p">:</span> <span class="s">"standalone"</span><span class="p">,</span> + <span class="s">"run_id"</span><span class="p">:</span> <span class="s">"43c5d003453b96e38ad3eae54026d8e1b078a7fd"</span><span class="p">,</span> + <span class="s">"uptime_in_days"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span> + <span class="s">"gcc_version"</span><span class="p">:</span> <span class="s">"4.4.6"</span><span class="p">,</span> + <span class="s">"arch_bits"</span><span class="p">:</span> <span class="s">"64"</span><span class="p">,</span> + <span class="s">"lru_clock"</span><span class="p">:</span> <span class="s">"16050046"</span><span class="p">,</span> + <span class="s">"multiplexing_api"</span><span class="p">:</span> <span class="s">"epoll"</span> + <span class="p">},</span> + <span class="s">"Keyspace"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"db0"</span><span class="p">:</span> <span class="s">"keys=26319,expires=0,avg_ttl=0"</span> + <span class="p">},</span> + <span class="s">"slowlog"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">[</span> + <span class="s">"32656"</span><span class="p">,</span> + <span class="s">"1425336191"</span><span class="p">,</span> + <span class="s">"18539"</span><span class="p">,</span> + <span class="p">[</span> + <span class="s">"keys"</span><span class="p">,</span> + <span class="s">"*"</span> + <span class="p">]</span> + <span class="p">]</span> + <span class="p">],</span> + <span class="s">"Persistence"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"rdb_bgsave_in_progress"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"loading"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"rdb_current_bgsave_time_sec"</span><span class="p">:</span> <span class="s">"-1"</span><span class="p">,</span> + <span class="s">"aof_enabled"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"rdb_last_bgsave_time_sec"</span><span class="p">:</span> <span class="s">"-1"</span><span class="p">,</span> + <span class="s">"aof_last_rewrite_time_sec"</span><span class="p">:</span> <span class="s">"-1"</span><span class="p">,</span> + <span class="s">"aof_last_write_status"</span><span class="p">:</span> <span class="s">"ok"</span><span class="p">,</span> + <span class="s">"rdb_last_bgsave_status"</span><span class="p">:</span> <span class="s">"ok"</span><span class="p">,</span> + <span class="s">"aof_last_bgrewrite_status"</span><span class="p">:</span> <span class="s">"ok"</span><span class="p">,</span> + <span class="s">"aof_current_rewrite_time_sec"</span><span class="p">:</span> <span class="s">"-1"</span><span class="p">,</span> + <span class="s">"aof_rewrite_scheduled"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"aof_rewrite_in_progress"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"rdb_last_save_time"</span><span class="p">:</span> <span class="s">"1424222403"</span><span class="p">,</span> + <span class="s">"rdb_changes_since_last_save"</span><span class="p">:</span> <span class="s">"2595831724"</span> + <span class="p">},</span> + <span class="s">"slowlen"</span><span class="p">:</span> <span class="mi">128</span><span class="p">,</span> + <span class="s">"CPU"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"used_cpu_user"</span><span class="p">:</span> <span class="s">"45252.98"</span><span class="p">,</span> + <span class="s">"used_cpu_sys"</span><span class="p">:</span> <span class="s">"154718.84"</span><span class="p">,</span> + <span class="s">"used_cpu_user_children"</span><span class="p">:</span> <span class="s">"0.00"</span><span class="p">,</span> + <span class="s">"used_cpu_sys_children"</span><span class="p">:</span> <span class="s">"0.00"</span> + <span class="p">},</span> + <span class="s">"Memory"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"used_memory_lua"</span><span class="p">:</span> <span class="s">"33792"</span><span class="p">,</span> + <span class="s">"mem_allocator"</span><span class="p">:</span> <span class="s">"jemalloc-3.6.0"</span><span class="p">,</span> + <span class="s">"used_memory_human"</span><span class="p">:</span> <span class="s">"5.25G"</span><span class="p">,</span> + <span class="s">"used_memory_peak_human"</span><span class="p">:</span> <span class="s">"8.08G"</span><span class="p">,</span> + <span class="s">"used_memory_peak"</span><span class="p">:</span> <span class="s">"8675798632"</span><span class="p">,</span> + <span class="s">"used_memory_rss"</span><span class="p">:</span> <span class="s">"8870088704"</span><span class="p">,</span> + <span class="s">"mem_fragmentation_ratio"</span><span class="p">:</span> <span class="s">"1.57"</span><span class="p">,</span> + <span class="s">"used_memory"</span><span class="p">:</span> <span class="s">"5633381640"</span> + <span class="p">},</span> + <span class="s">"Replication"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"repl_backlog_first_byte_offset"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"repl_backlog_active"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"repl_backlog_histlen"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"repl_backlog_size"</span><span class="p">:</span> <span class="s">"1048576"</span><span class="p">,</span> + <span class="s">"role"</span><span class="p">:</span> <span class="s">"master"</span><span class="p">,</span> + <span class="s">"master_repl_offset"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"connected_slaves"</span><span class="p">:</span> <span class="s">"0"</span> + <span class="p">},</span> + <span class="s">"Clients"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"client_biggest_input_buf"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"client_longest_output_list"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"blocked_clients"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"connected_clients"</span><span class="p">:</span> <span class="s">"16"</span> + <span class="p">},</span> + <span class="s">"Stats"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"latest_fork_usec"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"rejected_connections"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"sync_partial_ok"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"pubsub_channels"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"instantaneous_ops_per_sec"</span><span class="p">:</span> <span class="s">"2238"</span><span class="p">,</span> + <span class="s">"total_connections_received"</span><span class="p">:</span> <span class="s">"2502657"</span><span class="p">,</span> + <span class="s">"evicted_keys"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"pubsub_patterns"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"sync_full"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"keyspace_hits"</span><span class="p">:</span> <span class="s">"49388626"</span><span class="p">,</span> + <span class="s">"keyspace_misses"</span><span class="p">:</span> <span class="s">"780"</span><span class="p">,</span> + <span class="s">"total_commands_processed"</span><span class="p">:</span> <span class="s">"2645272238"</span><span class="p">,</span> + <span class="s">"expired_keys"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"sync_partial_err"</span><span class="p">:</span> <span class="s">"0"</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.1/redis/match/#match/start_date/:start_date/end_date/:end_date/interval/:interval.json</strong></p> +<p>Authentication Required:</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="33%" /> +<col width="10%" /> +<col width="56%" /> +</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">start_date</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">end_date</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">interval</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<p>Response Content Type: application/json</p> +<p><strong>Response Messages</strong></p> +<div class="highlight-python"><div class="highlight"><pre>HTTP Status Code: 200 +Reason: Success +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="38%" /> +<col width="24%" /> +<col width="38%" /> +</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> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="profile.html" class="btn btn-neutral" title="Profiles"><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:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/region.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/region.html b/docs/1.1.2/development/traffic_ops_rest/region.html new file mode 100644 index 0000000..d48ba00 --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/region.html @@ -0,0 +1,300 @@ + + +<!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>Regions — Traffic Control 1.1.2 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 1.1.2 documentation" href="../../index.html"/> + <link rel="up" title="Traffic Ops" href="../traffic_ops.html"/> + <link rel="next" title="Roles" href="role.html"/> + <link rel="prev" title="Redis" href="redis.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.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_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_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2 current"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Regions</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/region.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="redis.html" class="btn btn-neutral" title="Redis"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="regions"> +<span id="to-api-region"></span><h1>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/regions.json</strong></p> +<blockquote> +<div><p>Authentication Required:</p> +<p>Response Content Type: application/json</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> +<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s">"name"</span><span class="p">:</span> <span class="s">"Beltway"</span><span class="p">,</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="redis.html" class="btn btn-neutral" title="Redis"><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:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/role.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/role.html b/docs/1.1.2/development/traffic_ops_rest/role.html new file mode 100644 index 0000000..988aa63 --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/role.html @@ -0,0 +1,305 @@ + + +<!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>Roles — Traffic Control 1.1.2 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 1.1.2 documentation" href="../../index.html"/> + <link rel="up" title="Traffic Ops" href="../traffic_ops.html"/> + <link rel="next" title="Server" href="server.html"/> + <link rel="prev" title="Regions" href="region.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.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_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_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2 current"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Roles</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/role.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="server.html" class="btn btn-neutral float-right" title="Server">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="region.html" class="btn btn-neutral" title="Regions"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="roles"> +<span id="to-api-roles"></span><h1>Roles<a class="headerlink" href="#roles" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/roles.json</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</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> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">privLevel</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<td>string</td> +<td> </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">"name"</span><span class="p">:</span> <span class="s">"read-only"</span><span class="p">,</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span> + <span class="s">"privLevel"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span> + <span class="s">"description"</span><span class="p">:</span> <span class="s">"read-only user"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="server.html" class="btn btn-neutral float-right" title="Server">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="region.html" class="btn btn-neutral" title="Regions"><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:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
