40-api-net.html 15 KB


<!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>4. 网络配置接口 &mdash; tx1_serv 1.0 documentation</title>
  

  
  
  
  

  

  
  
    

  

  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="5. 系统时间设置接口" href="41-api-ntp.html" />
    <link rel="prev" title="3. 任务管理接口" href="30-api-task.html" /> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> tx1_serv
          

          
          </a>

          
            
            
              <div class="version">
                1.0
              </div>
            
          

          
<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">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="10-summary.html">1. 概述</a></li>
<li class="toctree-l1"><a class="reference internal" href="20-db.html">2. 数据库设计</a></li>
<li class="toctree-l1"><a class="reference internal" href="30-api-task.html">3. 任务管理接口</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">4. 网络配置接口</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id2">4.1. 本地网络配置</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id3">4.1.1. 配置本地网络</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">4.1.2. 获取本地网络</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id5">4.2. 中心网络配置</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id6">4.2.1. 配置中心网络</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id7">4.2.2. 获取中心网络</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id8">4.3. 运维网络配置</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id9">4.3.1. 配置运维网络</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">4.3.2. 获取运维网络</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="41-api-ntp.html">5. 系统时间设置接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="42-api-soft.html">6. 软件管理接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="50-api-dev.html">7. 系统运维接口</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">tx1_serv</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">Docs</a> &raquo;</li>
        
      <li>4. 网络配置接口</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/40-api-net.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="id1">
<h1>4. 网络配置接口<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h1>
<div class="section" id="id2">
<h2>4.1. 本地网络配置<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<div class="section" id="id3">
<h3>4.1.1. 配置本地网络<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<blockquote>
<div><div class="line-block">
<div class="line">Verb: POST</div>
<div class="line">Path: /api/v1/tx1/local_net</div>
<div class="line">Header: (authorization, {$auth_atoken}) (Content-Type, json)</div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Request</span> <span class="pre">Body</span></code>:</p>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;sub_mask&quot;</span><span class="p">:</span>   <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>  <span class="c1">#子网掩码</span>
  <span class="s2">&quot;gateway&quot;</span><span class="p">:</span>   <span class="s2">&quot;8.8.8.8&quot;</span><span class="p">,</span>
  <span class="s2">&quot;mac_addr&quot;</span><span class="p">:</span>   <span class="s2">&quot;f0:1f:af:d7:13:c0&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Response</span> <span class="pre">Body</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;sub_mask&quot;</span><span class="p">:</span>   <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>  <span class="c1">#子网掩码</span>
  <span class="s2">&quot;gateway&quot;</span><span class="p">:</span>   <span class="s2">&quot;8.8.8.8&quot;</span><span class="p">,</span>
  <span class="s2">&quot;mac_addr&quot;</span><span class="p">:</span>   <span class="s2">&quot;f0:1f:af:d7:13:c0&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="id4">
<h3>4.1.2. 获取本地网络<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<blockquote>
<div><div class="line-block">
<div class="line">Verb: GET</div>
<div class="line">Path: /api/v1/tx1/local_net</div>
<div class="line">Header: (authorization, {$auth_atoken}) (Content-Type, json)</div>
</div>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">Response</span> <span class="pre">Body</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;sub_mask&quot;</span><span class="p">:</span>   <span class="s2">&quot;255.255.255.0&quot;</span><span class="p">,</span>  <span class="c1">#子网掩码</span>
  <span class="s2">&quot;gateway&quot;</span><span class="p">:</span>   <span class="s2">&quot;8.8.8.8&quot;</span><span class="p">,</span>
  <span class="s2">&quot;mac_addr&quot;</span><span class="p">:</span>   <span class="s2">&quot;f0:1f:af:d7:13:c0&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div></blockquote>
</div>
</div>
<div class="section" id="id5">
<h2>4.2. 中心网络配置<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
<div class="section" id="id6">
<h3>4.2.1. 配置中心网络<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<blockquote>
<div><div class="line-block">
<div class="line">Verb: POST</div>
<div class="line">Path: /api/v1/tx1/center_net</div>
<div class="line">Header: (authorization, {$auth_atoken}) (Content-Type, json)</div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Request</span> <span class="pre">Body</span></code>:</p>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;port&quot;</span><span class="p">:</span>   <span class="s2">&quot;8081&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Response</span> <span class="pre">Body</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;port&quot;</span><span class="p">:</span>   <span class="s2">&quot;8081&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="id7">
<h3>4.2.2. 获取中心网络<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<blockquote>
<div><div class="line-block">
<div class="line">Verb: GET</div>
<div class="line">Path: /api/v1/tx1/center_net</div>
<div class="line">Header: (authorization, {$auth_atoken}) (Content-Type, json)</div>
</div>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">Response</span> <span class="pre">Body</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;port&quot;</span><span class="p">:</span>   <span class="s2">&quot;8081&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div></blockquote>
</div>
</div>
<div class="section" id="id8">
<h2>4.3. 运维网络配置<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h2>
<div class="section" id="id9">
<h3>4.3.1. 配置运维网络<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<blockquote>
<div><div class="line-block">
<div class="line">Verb: POST</div>
<div class="line">Path: /api/v1/tx1/dev_net</div>
<div class="line">Header: (authorization, {$auth_atoken}) (Content-Type, json)</div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Request</span> <span class="pre">Body</span></code>:</p>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;port&quot;</span><span class="p">:</span>   <span class="s2">&quot;8081&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Response</span> <span class="pre">Body</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;port&quot;</span><span class="p">:</span>   <span class="s2">&quot;8081&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="id10">
<h3>4.3.2. 获取运维网络<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<blockquote>
<div><div class="line-block">
<div class="line">Verb: GET</div>
<div class="line">Path: /api/v1/tx1/dev_net</div>
<div class="line">Header: (authorization, {$auth_atoken}) (Content-Type, json)</div>
</div>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">Response</span> <span class="pre">Body</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;ip&quot;</span><span class="p">:</span>   <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
  <span class="s2">&quot;port&quot;</span><span class="p">:</span>   <span class="s2">&quot;8081&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</div></blockquote>
</div>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="41-api-ntp.html" class="btn btn-neutral float-right" title="5. 系统时间设置接口" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="30-api-task.html" class="btn btn-neutral" title="3. 任务管理接口" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, XF.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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.0',
            LANGUAGE:'None',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  

  <script type="text/javascript" src="_static/js/theme.js"></script>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>