http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/phys_location.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/phys_location.html b/docs/latest/development/traffic_ops_api/v12/phys_location.html index b1c91b2..6d61ffd 100644 --- a/docs/latest/development/traffic_ops_api/v12/phys_location.html +++ b/docs/latest/development/traffic_ops_api/v12/phys_location.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Physical Location — Traffic Control master documentation </title> + <title>Physical Location — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Profiles" href="profile.html"/> <link rel="prev" title="Parameter" href="parameter.html"/> @@ -102,12 +102,15 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../../index.html">Traffic Control master</a> »</li> + <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -287,39 +292,39 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span> - <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span> - <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span> - <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane....@email.com"</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</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">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span> - <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span> - <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span> - <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span> - <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane....@email.com"</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</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">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span> - <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -354,13 +359,13 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -467,23 +472,23 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span> - <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span> - <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span> - <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane....@email.com"</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</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">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span> - <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -579,18 +584,18 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"regionId"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span> - <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doesssss"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span> - <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane....@email.com"</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span> - <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 9rd St"</span><span class="p">,</span> - <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span> +<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> <span class="p">}</span> </pre></div> </div> @@ -673,29 +678,29 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Physical location update was successful."</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Physical location update was successful."</span> <span class="p">}</span> <span class="p">],</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span> - <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span> - <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span> - <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span> - <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane....@email.com"</span><span class="p">,</span> - <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span> - <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</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">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span> - <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -788,14 +793,14 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"name"</span> <span class="p">:</span> <span class="s">"my physical location1"</span><span class="p">,</span> - <span class="s">"shortName"</span> <span class="p">:</span> <span class="s">"myphylocation1"</span><span class="p">,</span> - <span class="s">"address"</span> <span class="p">:</span> <span class="s">""</span><span class="p">,</span> - <span class="s">"city"</span> <span class="p">:</span> <span class="s">"Shanghai"</span><span class="p">,</span> - <span class="s">"state"</span><span class="p">:</span> <span class="s">"SH"</span><span class="p">,</span> - <span class="s">"zip"</span><span class="p">:</span> <span class="s">"200000"</span><span class="p">,</span> - <span class="s">"comments"</span><span class="p">:</span> <span class="s">"this is physical location1"</span> +<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span> + <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span> + <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span> <span class="p">}</span> </pre></div> </div> @@ -874,23 +879,23 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre> { - "response": { - 'shortName': 'myphylocati', - 'regionName': 'myregion1', - 'name': 'my physical location1', - 'poc': '', - 'phone': '', - 'comments': 'this is physical location1', - 'state': 'SH', - 'email': '', - 'zip': '20000', - 'region_id': '20', - 'city': 'Shanghai', - 'address': '', - 'id': '200' - } -} +<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span> + <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span> + <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span> + <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> + <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> + <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span> + <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span> + <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> + <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span> + <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span> + <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span> + <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> + <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span> + <span class="p">}</span> +<span class="p">}</span> </pre></div> </div> </div></blockquote> @@ -938,10 +943,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/profile.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/profile.html b/docs/latest/development/traffic_ops_api/v12/profile.html index 5c5f435..315ea3b 100644 --- a/docs/latest/development/traffic_ops_api/v12/profile.html +++ b/docs/latest/development/traffic_ops_api/v12/profile.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Profiles — Traffic Control master documentation </title> + <title>Profiles — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Profile parameters" href="profile_parameter.html"/> <link rel="prev" title="Physical Location" href="phys_location.html"/> @@ -102,12 +102,15 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../../index.html">Traffic Control master</a> »</li> + <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -211,7 +216,11 @@ <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal"><span class="pre">param</span></code></td> <td>no</td> -<td>Used to filter profiles by parameter.</td> +<td>Used to filter profiles by parameter ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> +<td>no</td> +<td>Used to filter profiles by CDN ID.</td> </tr> </tbody> </table> @@ -229,33 +238,48 @@ </tr> </thead> <tbody valign="top"> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> -<td>array</td> -<td>The Time / Date this server entry was last updated</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>Primary key</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> <td>string</td> <td>The name for the profile</td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> <td>string</td> -<td>Primary key</td> +<td>The description for the profile</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> +<td>int</td> +<td>The CDN ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> <td>string</td> -<td>The description for the profile</td> +<td>The CDN name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Profile type</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> +<td>array</td> +<td>The Time / Date this server entry was last updated</td> </tr> </tbody> </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"A profile with all the Foo parameters"</span> + <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span> + <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn1"</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -292,10 +316,10 @@ </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -344,33 +368,48 @@ </tr> </thead> <tbody valign="top"> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> -<td>array</td> -<td>The Time / Date this server entry was last updated</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>Primary key</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> <td>string</td> <td>The name for the profile</td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> <td>string</td> -<td>Primary key</td> +<td>The description for the profile</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> +<td>int</td> +<td>The CDN ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> <td>string</td> -<td>The description for the profile</td> +<td>The CDN name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Profile type</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> +<td>array</td> +<td>The Time / Date this server entry was last updated</td> </tr> </tbody> </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"A profile with all the Foo parameters"</span> + <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span> + <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn1"</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -383,7 +422,7 @@ <dl class="docutils"> <dt><strong>POST /api/1.2/profiles</strong></dt> <dd><blockquote class="first"> -<div><p>Create a new empty profile.</p> +<div><p>Create a new empty profile.</p> <blockquote> <div><p>Authentication Required: Yes</p> <p>Role(s) Required: admin or oper</p> @@ -392,31 +431,47 @@ <colgroup> <col width="28%" /> <col width="10%" /> -<col width="63%" /> +<col width="12%" /> +<col width="50%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Parameter</th> <th class="head">Type</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>string</td> -<td>The name of the new profile</td> +<td>yes</td> +<td>Profile name</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> <td>string</td> -<td>new profile description</td> +<td>yes</td> +<td>Profile description</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> +<td>int</td> +<td>no</td> +<td>CDN ID</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>yes</td> +<td>Profile type</td> </tr> </tbody> </table> </div></blockquote> </div></blockquote> <p><strong>Request Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span> +<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span><span class="p">,</span> + <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> <span class="p">}</span> </pre></div> </div> @@ -443,26 +498,36 @@ <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> <td>string</td> -<td>Id of the new profile</td> +<td>Profile ID</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 new profile</td> +<td>Profile name</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> <td>string</td> -<td>new profile description</td> +<td>Profile description</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> +<td>int</td> +<td>CDN ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Profile type</td> </tr> </tbody> </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span><span class="p">,</span> + <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -542,14 +607,14 @@ </div></blockquote> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span> - <span class="s">"profileCopyFrom"</span><span class="p">:</span> <span class="s">"CCR1"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span> - <span class="s">"idCopyFrom"</span><span class="p">:</span> <span class="s">"3"</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span> + <span class="s2">"profileCopyFrom"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span> + <span class="s2">"idCopyFrom"</span><span class="p">:</span> <span class="s2">"3"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -590,72 +655,85 @@ <p><strong>Request Properties</strong></p> <table border="1" class="docutils"> <colgroup> -<col width="22%" /> -<col width="13%" /> -<col width="65%" /> +<col width="28%" /> +<col width="10%" /> +<col width="12%" /> +<col width="50%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</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>string</td> <td>yes</td> -<td>The new name for the profile.</td> +<td>Profile name</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<td>string</td> +<td>yes</td> +<td>Profile description</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> +<td>int</td> +<td>no</td> +<td>CDN ID - must use the same ID as any +servers assigned to the profile.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> <td>yes</td> -<td>The new description for the profile.</td> +<td>Profile type</td> </tr> </tbody> </table> </div></blockquote> </div></blockquote> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>{ - "name": "CCR_UPDATE", - "description": "CCR_UPDATE description" +<div class="highlight-default"><div class="highlight"><pre><span></span>{ + "name": "EDGE_28_PROFILE", + "description": "EDGE_28_PROFILE description", + "cdn": 1, + "type": "ATS_PROFILE" } **Response Properties** - +------------------+--------+----------------------------------+ - | Parameter | Type | Description | - +==================+========+==================================+ - | ``response`` | | The updated profile info. | - +------------------+--------+----------------------------------+ - | ``>id`` | string | Profile id. | - +------------------+--------+----------------------------------+ - | ``>name`` | string | Profile name. | - +------------------+--------+----------------------------------+ - | ``>description`` | string | Profile description. | - +------------------+--------+----------------------------------+ - | ``alerts`` | array | A collection of alert messages. | - +------------------+--------+----------------------------------+ - | ``>level`` | string | success, info, warning or error. | - +------------------+--------+----------------------------------+ - | ``>text`` | string | Alert message. | - +------------------+--------+----------------------------------+ - | ``version`` | string | | - +------------------+--------+----------------------------------+ + +-----------------------+--------+----------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========+====================================================+ + | ``id`` | string | Profile ID | + +-----------------------+--------+----------------------------------------------------+ + | ``name`` | string | Profile name | + +-----------------------+--------+----------------------------------------------------+ + | ``description`` | string | Profile description | + +-----------------------+--------+----------------------------------------------------+ + | ``cdn`` | int | CDN ID | + +-----------------------+--------+----------------------------------------------------+ + | ``type`` | string | Profile type | + +-----------------------+--------+----------------------------------------------------+ </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>{ - "response":{ - "id": "219", - "name": "CCR_UPDATE", - "description": "CCR_UPDATE description" - } - "alerts":[ - { - "level": "success", - "text": "Profile was updated: 219" - } - ] -} +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"219"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span> + <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span> + <span class="p">}</span> + <span class="s2">"alerts"</span><span class="p">:[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile was updated: 219"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> </pre></div> </div> </div></blockquote> @@ -722,11 +800,11 @@ </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Profile was deleted."</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">"Profile was deleted."</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -777,10 +855,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/profile_parameter.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/profile_parameter.html b/docs/latest/development/traffic_ops_api/v12/profile_parameter.html index e9d3a68..0364d41 100644 --- a/docs/latest/development/traffic_ops_api/v12/profile_parameter.html +++ b/docs/latest/development/traffic_ops_api/v12/profile_parameter.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Profile parameters — Traffic Control master documentation </title> + <title>Profile parameters — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="InfluxDB" href="influxdb.html"/> <link rel="prev" title="Profiles" href="profile.html"/> @@ -102,12 +102,15 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../../index.html">Traffic Control master</a> »</li> + <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -254,7 +259,7 @@ This accept two formats: single profile-parameter, profile-parameter array.</p> </div></blockquote> </div></blockquote> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>Single profile-parameter format: +<div class="highlight-default"><div class="highlight"><pre><span></span>Single profile-parameter format: { "profileId": 2, @@ -300,28 +305,28 @@ Profile-parameter array format: </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>{ - "response":[ - { - "profileId": "2", - "parameterId": "6" - }, - { - "profileId": "2", - "parameterId": "7" - }, - { - "profileId": "3", - "parameterId": "6" - } - ] - "alerts":[ - { - "level": "success", - "text": "Profile parameter associations were created." - } - ] -} +<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">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"7"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> + <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="s2">"alerts"</span><span class="p">:[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile parameter associations were created."</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> </pre></div> </div> </div></blockquote> @@ -394,11 +399,11 @@ Profile-parameter array format: </div></blockquote> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:[</span> +<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Profile parameter association was deleted."</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">"Profile parameter association was deleted."</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -522,33 +527,33 @@ The request properties accept 2 formats, both single paramter and parameters arr </table> </div></blockquote> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>1. single parameter format exampe: -{ - "name":"param1", - "configFile":"configFile1", - "value":"value1", - "secure":0, -} +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</span> +<span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> +<span class="p">}</span> -2. array format example: -[ - { - "name":"param1", - "configFile":"configFile1", - "value":"value1", - "secure":0, - }, - { - "name":"param2", - "configFile":"configFile2", - "value":"value2", - "secure":1, - } -] +<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</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">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</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">"param2"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> + <span class="p">}</span> +<span class="p">]</span> </pre></div> </div> <p><strong>Response Properties</strong></p> -<div class="highlight-python"><div class="highlight"><pre>+------------------+---------+--------------------------------------------------------------------------------------+ +<div class="highlight-default"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+ | Name | Type | Description | +==================+=========+======================================================================================+ | ``response`` | | Parameters associated with the profile. | @@ -580,32 +585,32 @@ The request properties accept 2 formats, both single paramter and parameters arr </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>{ - "response":{ - "profileName": "CCR1", - "profileId" : "12", - "parameters":[ - { - "name":"param1", - "configFile":"configFile1" - "value":"value1", - "secure":"0", - }, - { - "name":"param2", - "configFile":"configFile2" - "value":"value2", - "secure":"1", - } - ] - } - "alerts":[ - { - "level": "success", - "text": ""Assign parameters successfully to profile CCR1" - } - ] -} +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:{</span> + <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span> + <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span> + <span class="s2">"parameters"</span><span class="p">:[</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</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">"param2"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">}</span> + <span class="s2">"alerts"</span><span class="p">:[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> </pre></div> </div> </div></blockquote> @@ -726,33 +731,33 @@ The request properties accept 2 formats, both single paramter and parameters arr </table> </div></blockquote> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>1. single parameter format exampe: -{ - "name":"param1", - "configFile":"configFile1", - "value":"value1", - "secure":0, -} +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</span> +<span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> +<span class="p">}</span> -2. array format example: -[ - { - "name":"param1", - "configFile":"configFile1", - "value":"value1", - "secure":0, - }, - { - "name":"param2", - "configFile":"configFile2", - "value":"value2", - "secure":1, - } -] +<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</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">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</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">"param2"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> + <span class="p">}</span> +<span class="p">]</span> </pre></div> </div> <p><strong>Response Properties</strong></p> -<div class="highlight-python"><div class="highlight"><pre>+------------------+---------+--------------------------------------------------------------------------------------+ +<div class="highlight-default"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+ | Name | Type | Description | +==================+=========+======================================================================================+ | ``response`` | | Parameters associated with the profile. | @@ -784,32 +789,32 @@ The request properties accept 2 formats, both single paramter and parameters arr </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>{ - "response":{ - "profileName": "CCR1", - "profileId" : "12", - "parameters":[ - { - "name":"param1", - "configFile":"configFile1" - "value":"value1", - "secure":"0", - }, - { - "name":"param2", - "configFile":"configFile2" - "value":"value2", - "secure":"1", - } - ] - } - "alerts":[ - { - "level": "success", - "text": ""Assign parameters successfully to profile CCR1" - } - ] -} +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:{</span> + <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span> + <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span> + <span class="s2">"parameters"</span><span class="p">:[</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</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">"param2"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">}</span> + <span class="s2">"alerts"</span><span class="p">:[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> </pre></div> </div> </div></blockquote> @@ -857,10 +862,11 @@ The request properties accept 2 formats, both single paramter and parameters arr <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script>
