65-wsapi-operation.rst.txt

ws_运维接口
=====================

.. note:: 
  - 本文档中的dev_unid表示运维设备的unid，device_id表示运维设备下物理设备的id。
  - 与对应http接口的区别在于http接口给客户端的响应只能确认请求收到，不能确保运维已执行完成，而后者必须等待运维服务给出正确的响应后再给客户端响应。


.. _modify_fx_dev_info:

修改繁星设备信息
^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "put /wsapi/v1/devconf_fx/ops/fx_devs",
      "src_page": "xxxx",
      "params": {
        "dev_unid": "xxxx",    # 运维设备的unid                                      
        "device_id":"1234",    # 繁星设备的id
        # 以下内容参见15.1.3. 修改繁星设备信息的请求部分
        ...
      }
    }

``Response``: 标准响应


.. _ws_get_ops_status: 

获取运维服务状态
^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/fx_devs/status",
      "src_page": "xxxx",
      "params": {
        "dev_unid": "xxxx", # 运维设备的unid                            
      }
    }

``Response``: 

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/fx_devs/status",
      "src_page": "xxxx",
      "result": {
        # 以下内容参见15.1.4. 获取运维服务状态的响应部分
        ...
      }
    }


.. _ws_get_fx_devs_status: 

获取繁星设备状态信息
^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/status",
      "src_page": "xxxx",
      "params": {
        "dev_unid": "xxxx",    # 运维设备的unid
        "device_id":"1234",    # 繁星设备的id
      }
    }

``Response``: 

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/status",
      "src_page": "xxxx",
      "result": {
        # 以下内容参见15.1.5. 获取繁星设备状态信息的响应部分
        ...
      }
    }


网络配置
-----------------------

获取繁星主设备网络配置信息
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
参考: :ref:`ws_get_fx_devs_status` , 然后从中间找出主设备

获取繁星从设备网络信息
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
参考: :ref:`ws_get_fx_devs_status` 接口，过滤出所有的从设备


修改繁星设备网络配置
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
参考: :ref:`modify_fx_dev_info` 


时间配置
----------------------

获取设备时间
^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/fx_devs/time",
      "src_page": "xxxx",
      "params": {
        "dev_unid": "xxxx",    # 运维设备的unid                                      
        "device_id":"1234",    # 繁星设备的id
      }
    }

``Response``: 

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/fx_devs/time",
      "src_page": "xxxx",
      "result": {
          # 以下内容参见15.3.1. 获取设备时间的响应部分
          ...
      }
    }


手动校时
^^^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "put /wsapi/v1/devconf_fx/ops/fx_devs/time",
      "src_page": "xxxx",
      "params": {
        "dev_unid": "xxxx",    # 运维设备的unid                                      
        "device_id":"1234",    # 繁星设备的id
        "time": "2017-01-01 11:20:00"
      }
    }

``Response``: 标准响应


获取校时配置信息
^^^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/fx_devs/timing/ntp",
      "src_page": "xxxx",
      "params": {
        "dev_unid": "xxxx",    # 运维设备的unid                                      
        "device_id":"1234",    # 繁星设备的id
      }
    }

``Response``: 

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/fx_devs/timing/ntp",
      "src_page": "xxxx",
      "result": {
          # 以下内容参见15.3.3. 获取校时配置信息的响应部分
          ...
      }
    }


设置NTP校时信息
^^^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "put /wsapi/v1/devconf_fx/ops/fx_devs/timing/ntp",
      "src_page": "xxxx",
      "params": {
          "dev_unid": "xxxx",    # 运维设备的unid                                      
          "device_id":"1234",    # 繁星设备的id
          # 以下内容参见15.3.4. 设置NTP校时信息的请求部分
          ...
      }
    }

``Response``: 标准响应。


系统维护
-------------------

恢复出厂设置
^^^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "post /wsapi/v1/devconf_fx/ops/fx_devs/factory-reset",
      "src_page": "xxxx",
      "params": {
          "dev_unid": "xxxx",    # 运维设备的unid                                      
          "device_id":"1234",    # 繁星设备的id
      }
    }

``Response``: 标准响应。


手动重启设备
^^^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "post /wsapi/v1/devconf_fx/ops/fx_devs/reboot/manual",
      "src_page": "xxxx",
      "params": {
          "dev_unid": "xxxx",    # 运维设备的unid                                      
          "device_id":"1234",    # 繁星设备的id
      }
    }

``Response``: 标准响应。

获取自动重启配置
^^^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "get /wsapi/v1/devconf_fx/ops/fx_devs/reboot/auto",
      "src_page": "xxxx",
      "params": {
          "dev_unid": "xxxx",    # 运维设备的unid                                      
          "device_id":"1234",    # 繁星设备的id
      }
    }

``Response``:

  .. code-block:: python

    {
      "command": "get /wsapi/v1/devconf_fx/ops/fx_devs/reboot/auto",
      "src_page": "xxxx",
      "result": {
          # 以下内容参见15.4.6. 获取自动重启配置的响应部分
          ...
      }
    }

设置自动重启策略
^^^^^^^^^^^^^^^^^^^^^^^^

``Request Body``:

  .. code-block:: python
  
    {
      "command": "put /wsapi/v1/devconf_fx/ops/fx_devs/reboot/auto",
      "src_page": "xxxx",
      "params": {
          "dev_unid": "xxxx",    # 运维设备的unid                                      
          "device_id":"1234",    # 繁星设备的id
          # 以下内容参见15.4.7. 设置自动重启策略的请求部分
          ...
      }
    }

``Response``: 标准响应