API文档

{
  "network_name": "my_network",
  "network_description": "",
  "constellation": {
    "name": "my_constellation",
    "type": "walker_delta", //default walker_delta
    "orbit_altitude": 550,
    "orbit_inclination": 53,
    "orbit_num": 60,
    "sat_num_per_orbit": 60,
    "phase_shift": 1,
    "sat_isl_link_num": 4, //default 4
    "sat_gsl_link_num": 1, //default 1
    "sat_access_link_num": 1 //default 1
  },
  "gs_set": [
    {
      "name": "GS0",
      "latitude": 25.1,
      "longitude": 123.1,
      "elevation": 121.1,
      "gs_antenna_num": 1, //default 1
      "gs_antenna_angle": 1 //default 1
    },
    {
      "name": "GS1",
      "latitude": 24.1,
      "longitude": 125.1,
      "elevation": 126.1,
      "gs_antenna_num": 1, //default 1
      "gs_antenna_angle": 1 //default 1
    }
  ]
}

{
  "status": "success",
  "network_id": 111, // 返回网络ID，用于网络准备阶段监控
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/list?page=1&pageSize=10&name=test&status=1&sortBy=create_time&sortOrder=desc

{
  "status": "success",
  "total": 100,
  "pages": 10,
  "page": 1,
  "pageSize": 10,
  "data": [
    {
      "network_id": 111,
      "network_name": "my_network",
      "network_status": 1,
      "network_type": 1,
      "create_time": "2024-03-24 15:10:00"
    }
  ]
}

{
  "status": "error",
  "msg": "参数错误"
}

GET /api/network/60/run/

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/60/destroy/

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/60/reset/

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

WebSocket /ws/network/60/status/

{"message": "create"}
{"message": "destroy"}

{
  "type": "update",
  "data": {
    "status": "topo_creating", //网络拓扑创建中
    "progress": 0.1, //完成进度，10%
    "estimated_time": 10 // 预估时间，分钟（全局预估时间，不是阶段预估时间）
  }
}

{
  "type": "error",
  "msg": "Error message here..."
}

GET /api/network/60/reset/

{
  "status": "success",
  "network_id": 111,
  "network_name": "my_network",
  "network_description": "",
  "network_status": 0, // 0-暂存/1-运行中
  "network_type": 0, // 0-卫星 1-BGP
  "create_time": "2024:03:24 15:10:00", // 创建时间  YYYY-mm-dd HH:mm:ss
  "constellation": {
    "name": "my_constellation",
    "type": "walker_delta", //default walker_delta
    "orbit_altitude": 550,
    "orbit_inclination": 53,
    "orbit_num": 60,
    "sat_num_per_orbit": 60, 
    "phase_shift": 1,
    "sat_isl_link_num": 4, //default 4
    "sat_gsl_link_num": 1, //default 1
    "sat_access_link_num": 1, //default 1
  },
  "gs_set": [
    {
      "gs_id": 0,
      "node_id": -1,
      "name": "GS0",
      "latitude": 25.1,
      "longitude": 123.1,
      "elevation": 121.1,
      "gs_antenna_num": 1, //default 1
      "gs_antenna_angle": 1, //default 1
    },
    {
      "gs_id": 1,
      "node_id": -1,
      "name": "GS1",
      "latitude": 24.1,
      "longitude": 125.1,
      "elevation": 126.1,
      "gs_antenna_num": 1, //default 1
      "gs_antenna_angle": 1, //default 1
    },
  ],
  "user_terminals": [
    {
      "end_user_id": -1,
      "node_id": -1,
      "name": "alice",
      "latitude": 25.1,
      "longitude": 123.1,
      "elevation": 121.1,
    },
    {
      "end_user_id": -1,
      "node_id": -1,
      "name": "bob",
      "latitude": 35.1,
      "longitude": 143.1,
      "elevation": 125.1,
    }
  ]
}

{
  "status": "success",
  "network_id": 111,
  "network_name": "my_network",
  "network_description": "",
  "network_status": 0, // 0-暂存/1-运行中
  "network_type": 1, // 0-卫星 1-BGP
  "create_time": "2024:03:24 15:10:00", // 创建时间  YYYY-mm-dd HH:mm:ss
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/60/remove/

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/60/file/delete

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/60/file/default/download

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/60/image/prepare

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/force_clean/

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/network/60/file/current/download

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/cluster/health

{
  "status": "success",
  "expected_nodes": 8,
  "online_nodes": 8
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/vnode/list?page=1&pageSize=10&node_name=test&status=1&sortBy=node_id&sortOrder=desc

GET /api/vnode/list?lite=1

{
    "status": "success",
    "total": 4,
    "pages": 1,
    "page": 1,
    "pageSize": 10,
    "data": [
        {
            "node_id": 1,
            "node_name": "node0",
            "alias": "AS1",
            "current_status": 1,
            "image": "ponedo/frr-ubuntu20:tiny",
            "node_type": "test",
            "physical": true
        }
    ]
}

{
    "status": "success",
    "data": [
        {
            "node_id": 0,
            "node_name": "Sat0",
            "alias": "AS1"
        },
        {
            "node_id": 1,
            "node_name": "Sat1",
            "physical": true
        }
    ]
}

{
    "status": "error",
    "msg": "参数错误"
}

GET /api/vnode/30/update?action=down

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

{
    "action": "up",
    "node_ids": [1, 2, 3]
}

{
  "status": "success",
  "action": "up",
  "node_ids": [1, 2, 3]
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/vnode/action/list?type=0

{
  "status": "success",
  "action_list": [
      {"action_id": 1, "action_name": "操作名称", "type": 0},
      {"action_id": 12, "action_name": "操作名称", "type": 0},
  ]
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/vnode/action/12/info

{
    "status": "success",
    "action_id": 12, 
    "action_name": "操作名称",
    "shell": "/bin/bash",
    "type": 1, // 0-可编辑模板 1-直接执行
    "echo": 1, // echo表示需要返回该命令的输出结果
    "cmd_list": [
        {"cmd": "config terminal"},
        {"cmd": "router bgp <input:as_number>"},
        {"cmd": "network <input:cidr_ip>"},  
    ]
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/vnode/<node-id>/terminal/?cmd=%2Fusr%2Fbin%2Fbash

{
   "status": "success",
   "terminal_url": "ws://172.10.80.158:8080/api/virtnet/ws/terminal/?network_id=1&node_id=1&cmd=%2Fusr%2Fbin%2Fbash"
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/vnode/action/12/delete

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

WebSocket /ws/vnode/<node-id>/exec/

{
  "cmd_list": [
    "config terminal",
    "router bgp <input:as_number>",
    "network <input:cidr_ip>"
  ]
}

{
  "type": "update",
  "data": [
    "1234567890",
    "1234567890",
    "1234567890",
  ]
}

{
  "type": "error",
  "msg": "Error message here..."
}

POST /api/vlink/12-15-30-5/update/

{
  "op": "up",
}

{
  "status": "success",
   "link_id":"12-15-30-5",
   "op": "up"
}

{
  "status": "error",
  "msg": "错误信息"
}

{
  "op": "traffic_control",
  "args": {
    "bw": 1000, //带宽1000Mbps
    "delay": -1, //系统自由管理
    "loss": 0.3, //丢包率30%
  }
}

{
  "status": "success",
   "link_id":"12-15-30-5",
   "op": "traffic_control"
}

{
  "status": "error",
  "msg": "错误信息"
}

POST /api/vlink/update/batch/

{
    "op":"down",
    "link_ids":["4-25-5-30","3-20-26-159"]
}

{
  "status": "success",
  "action": "down",
  "link_ids":["4-25-5-30","3-20-26-159"]
}

{
  "status": "error",
  "msg": "错误信息"
}

{
    "op":"traffic_control",
    "link_ids":["4-25-5-30","3-20-26-159"],
    "args": {
        "bw": 1000, //带宽1000Mbps
        "delay": -1, //系统自由管理
        "loss": 0.3, //丢包率30%
    }
}

{
  "status": "success",
  "action": "traffic_control",
  "link_ids":["4-25-5-30","3-20-26-159"]
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/satvis/ground_station/info

{
    "status": "success",
    "gs_list":[
        {
            "gs_id": 0,
            "node_id": 100, //虚拟节点id
            "name": "GS0",
            "latitude": 25.1,
            "longitude": 123.1,
            "elevation": 121.1,
            "gs_antenna_num": 1,
            "gs_antenna_angle": 1,
            "status": "UP",
            "physical": true
        },
        {
            "gs_id": 1,
            "node_id": 101, //虚拟节点id
            "name": "GS1",
            "latitude": 24.1,
            "longitude": 125.1,
            "elevation": 126.1,
            "gs_antenna_num": 1,
            "gs_antenna_angle": 1,
            "status": "DOWN",
            "physical": false
        },
    ]
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/satvis/scenario/list

{
    "status": "success",
    "scenario_list":[
        {
            "scenario_id": 1,
            "scenario_name":"2024年冬至",
            "scenario_status": 1 // 已经计算，可选
        },
        {
            "scenario_id": 2,
            "scenario_name":"2024年冬至",
            "scenario_status": 2 // 运行中
        }
    ]
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/satvis/scenario/create

{
  "scenario_name": "test", //场景名称
  "start_time": "2024-06-22T00:00:00+08:00", //场景起始时间
  "duration": 60, //场景持续时间
  "granularity": 1, //物理引擎模型粒度（秒）
  "position_update_interval": 10, //卫星位置前端渲染更新时间粒度（单位为秒，必须被granularity整除，默认与granularity一致）
  "event_update_interval": 10, //链路状态与属性更新时间粒度（单位为秒，必须被granularity整除，默认为大于10s的最小值）
  "sun_outage_critical_angle": 5, //日凌判定链路太阳光夹角（单位为度，default 5）
  "laser_outage_rate": 0.1, //异轨星间链路异常发生概率（default 0.1）
  "gsl_plan_method": "min_distance", //星地链路切换策略（预置选项包括min_distance；可选customized，此时用户需要上传星地切换策略至共享盘；默认min_distance）
}

{
    "status": "success",
    "scenario_id": 1,
}

{
    "status": "error",
    "msg": "错误信息"
}

GET /api/satvis/scenario/2/info

{
  "status": "success",
  "network_id": 0,
  "scenario_id": 2,
  "scenario_name": "test", //场景名称
  "start_time": "2024-06-22T00:00:00+08:00", //场景起始时间
  "duration": 60, //场景持续时间
  "granularity": 1, //物理引擎模型粒度（秒）
  "position_update_interval": 10, //卫星位置前端渲染更新时间粒度（单位为秒，必须被granularity整除，默认与granularity一致）
  "event_update_interval": 10, //链路状态与属性更新时间粒度（单位为秒，必须被granularity整除，默认为大于10s的最小值）
  "sun_outage_critical_angle": 5, //日凌判定链路太阳光夹角（单位为度，default 5）
  "laser_outage_rate": 0.1, //异轨星间链路异常发生概率（default 0.1）
  "gsl_plan_method": "min_distance", //星地链路切换策略（预置选项包括min_distance；可选customized，此时用户需要上传星地切换策略至共享盘；默认min_distance）
  "created_time": "2024-06-21T16:00:00+0000", //default 1
  "scenario_status": 0, // 0-计算中 1-就绪 2-运行中 200-计算失败
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/satvis/scenario/2/delete

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/satvis/scenario/2/play

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/satvis/scenario/status

{
    "status": "success",
    "emulation_status": 1, // 0-无仿真任务 1-正在仿真
    "network_id": 1, //当前网络id
    "scenario_id": 1 //当前场景id
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/satvis/2/sat_trajectory

{
  "status": "success",
  "startTime":"2024:03:24T15:10:00Z", //全部时间-开始时间   时间格式为 ISO8601 
  "endTime":"2024:03:24T15:10:00Z", //全部时间-结束时间
  "starNetData": [
    {
      "sat_id": 0,  //星星id
      "node_id": 0, //虚拟节点id
      "status": "DOWN", //状态
      "physical": true,
      "host": [
          {"node_id":100,"node_name":"Sat100_host"}
      ], //host，星载
      "description": "Sat0", //星星描述
      "epochTime":"2024:03:24T15:10:00Z", //星星轨迹-开始时间
      "pathData": [
        {
            "time": "2024:03:24T15:10:00Z", //当前时间
            "timeInterval":0,  //当前时间距离开始时间秒数
            "lat": 30, //纬度
            "lon": 175, //经度
            "height": 15200 //高度
        },
        {
            "time": "2024:03:24T15:10:03Z",
            "timeInterval":300,
            "lat": 30,
            "lon": 175,
            "height": 15200
        }
      ]
    },
    {
      "sat_id": 1,  //星星id
      "node_id": 1, //虚拟节点id
      "status": "UP", //状态
      "physical": false,
      "host": [], //host，星载
      "description": "Sat1", //星星描述
      "epochTime":"2024:03:24T15:10:00Z",
      "pathData":[
        {
          "time": "2024:03:24T15:10:00Z",
          "timeInterval":0,
          "lat": 30,
          "lon": 175,
          "height": 15200
        }
      ]
    }
  ]
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/satvis/2/init_edge_list

{
  "status": "success",
  "current_seconds": 12, // 当前播放进度(秒)，相对于start_time的差值
  "links": [
    {
      "link_id": "0-1-1-4", //虚拟链路id
      "source_node_id": 0, //开始节点id
      "target_node_id": 1, //结束节点id
      "linkType": "intra-orbit",
      "linkStatus": ["Normal"]
    },
    {
      "link_id": "1-7-11-46", //虚拟链路id
      "source_node_id": 1,
      "target_node_id": 11,
      "linkType": "inter-orbit",
      "linkStatus": ["Sun-outage"]
    },
    {
      "link_id": "1-7-12-51", //虚拟链路id
      "source_node_id": 1,
      "target_node_id": 12,
      "linkType": "inter-orbit",
      "linkStatus": ["User-outage", "Sun-outage"] //链路状态，可能同时处于多种状态。渲染时，按照linkStatus列表中的第一个状态渲染该链路的颜色。
    },
    {
      "link_id": "1-10-101-1123", //虚拟链路id
      "source_node_id": 101,
      "target_node_id": 1,
      "linkType": "",
      "linkStatus": ["Normal"]
    },
    {
      "link_id": "16-111-104-1126", //虚拟链路id
      "source_node_id": 104,
      "target_node_id": 16,
      "linkType": "",
      "linkStatus": ["Normal"]
    }
  ]
}

{
  "status": "error",
  "msg": "错误信息"
}

WebSocket /ws/satvis/2/link_attributes/12-45-1-3

"SERNES"

{
  "current_seconds": 12, // 当前播放进度(秒)，相对于start_time的差值
  "source_node_id": 122,
  "target_node_id": 123,
  "source_node_name": "Sat122",
  "target_node_name": "Sat123",
  "online": true, // 当前此链路是否在线（没有被用户手动置为Outage），若是则为true，否则为false
  "bandwidth": 1000,
  "loss": 0.01,
  "delay": 5000,
}

GET /api/satvis/scenario/2/terminate

{
  "status": "success"
}

{
  "status": "error",
  "msg": "错误信息"
}

WebSocket /ws/satvis/2/link_attributes/12-45-1-3

"SERNES"

{
  "current_seconds": 12, // 当前播放进度(秒)，相对于start_time的差值
  "source_node_id": 122,
  "target_node_id": 123,
  "source_node_name": "Sat122",
  "target_node_name": "Sat123",
  "online": true, // 当前此链路是否在线（没有被用户手动置为Outage），若是则为true，否则为false
  "bandwidth": 1000,
  "loss": 0.01,
  "delay": 5000,
}

GET /api/bgpvis/topology

{
    "status": "success",
    "network_id": 0,
    "nodes": [
        {
            "id": 1,
            "name": "AS1",
            "type": "router",
            "alias": "AS1",
            "status": "DOWN",
            "physical": true,
            "x": [
                -591.8478005191374,
                1602
            ],
            "y": [
                31.618981283416005,
                782
            ]
        }
    ],
    "links": [
        {
            "id": "1",
            "source_id": 2,
            "target_id": 3,
            "status": "UP"
        }
    ]
}

{
  "status": "error",
  "msg": "错误信息"
}

POST /api/bgpvis/topology/save

{
    "node0" : {
        "x": [
            -163.21903797733037,
            1602
        ],
        "y": [
            -215.65374598931172,
            782
        ]
    },
    "node1": {
        "x": [
            -591.8478005191374,
            1602
        ],
        "y": [
            31.618981283416005,
            782
        ]
    }
} 

{
  "status": "success",
}

{
  "status": "error",
  "msg": "错误信息"
}

WebSocket /ws/bgpvis/status/

{
  "type": "link-update",
  "data": [
      {
        "link_id": "link0",
        "event": "UP" // UP DOWN
      },
      {
        "link_id": "link1",
        "event": "DOWN" // UP DOWN
      }
  ]
}

{
  "type": "node-update",
  "data": [
      {
        "node_id": 132,
        "event": "UP" // UP DOWN
      },
      {
        "node_id": 135,
        "event": "DOWN" // UP DOWN
      }
  ]
}

{
  "type": "error",
  "msg": "Error message here..."
}

WebSocket /ws/bgpvis/link_attributes/Node122-Node123-12-84

"SERNES"

{
  "type": "success",
  "source_node_id": 122,
  "target_node_id": 123,
  "source_node_name": "Node122",
  "target_node_name": "Node123",
  "online": true,
  "bandwidth": 1000,
  "loss": 0.01,
  "delay": 5000,
}

{
  "type": "error",
  "msg": "Error message here..."
}

GET /api/tools/status

{
    "status": "success",
    "pcap_status": 1 //抓包工具状态 0-未运行 1-正在运行
}

{
  "status": "error",
  "msg": "错误信息"
}

POST /api/tools/log/download

{
    "nodes": [12, 23, 56, 76], // NodeID
    "volumes": "/var/log" //必须是用户在yaml中配置过的volume
} 

{
  "status": "error",
  "msg": "错误信息"
}

POST /api/tools/pcap/start

{
    "nodes": [12, 23, 56, 76], // NodeID
}

{
    "status": "success",
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/tools/pcap/stop

{
    "status": "success",
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/tools/pcap/12/list

{
  "status": "success",
  "data": [
       "20240705_175143.pcap",
       "20240705_175146.pcap"
  ]
}

{
  "status": "error",
  "msg": "错误信息"
}

GET /api/tools/pcap/download?network_id=12&file_name=20240705_175146.pcap

{
    "nodes": [12, 23, 56, 76], // NodeID
    "volumes": "/var/log" //必须是用户在yaml中配置过的volume
} 

{
  "status": "error",
  "msg": "错误信息"
}