|
|
@@ -6,6 +6,12 @@ StackHub主要架构和技术选型如下：
|
|
|
|
|
|
## 后端接口说明
|
|
|
|
|
|
+### 用户相关（登陆，退出，注册等 待讨论？）
|
|
|
+
|
|
|
+### APP详情（是否共用websoft9主站信息 待讨论？）
|
|
|
+
|
|
|
+### APP列表（是否共用websoft9主站信息 待讨论？）
|
|
|
+
|
|
|
### App安装接口（installApp）
|
|
|
|
|
|
#### 接口地址
|
|
|
@@ -22,7 +28,7 @@ Http（get/post）
|
|
|
|
|
|
| 变量名 | 说明 | 类型 | 备注 |
|
|
|
| ------------ | ------------ | ----- |----- |
|
|
|
-| appName | 安装app的名称| str |可选 |
|
|
|
+| appName | 安装app的名称| str |必须 |
|
|
|
|
|
|
e.g.
|
|
|
```
|
|
|
@@ -73,7 +79,7 @@ Http（get/post）
|
|
|
|
|
|
| 变量名 | 说明 | 类型 | 备注 |
|
|
|
| ------------ | ------------ | ----- |----- |
|
|
|
-| appName | 卸载app的名称| str |可选 |
|
|
|
+| appName | 卸载app的名称| str |必须 |
|
|
|
|
|
|
e.g.
|
|
|
```
|
|
|
@@ -95,4 +101,98 @@ e.g.
|
|
|
"code":"0",
|
|
|
"message":"appName卸载失败，任然在运行，端口为9001，请ssh登陆如服务器后使用docker-ps查看，并手动停止容器"
|
|
|
}
|
|
|
-```
|
|
|
+```
|
|
|
+
|
|
|
+
|
|
|
+### App状态查询接口（getAppInfo）
|
|
|
+
|
|
|
+#### 接口地址
|
|
|
+
|
|
|
+http://ip:port/getAppInfo
|
|
|
+
|
|
|
+#### 访问方式
|
|
|
+
|
|
|
+Http（get/post）
|
|
|
+同步/异步：同步
|
|
|
+
|
|
|
+
|
|
|
+#### 接口参数
|
|
|
+
|
|
|
+| 变量名 | 说明 | 类型 | 备注 |
|
|
|
+| ------------ | ------------ | ----- |----- |
|
|
|
+| appName | 安装app的名称| str |必须 |
|
|
|
+
|
|
|
+e.g.
|
|
|
+```
|
|
|
+{
|
|
|
+ "appName":"redmine"
|
|
|
+}
|
|
|
+```
|
|
|
+#### 返回数据
|
|
|
+
|
|
|
+| 变量名 | 说明 | 类型 | 备注 |
|
|
|
+| ------------ | ------------ | ----- |----- |
|
|
|
+| code | 接口是否调用成功标志| str |"0":失败 "1":成功 |
|
|
|
+| message | 接口返回信息| str |如接口调用成功时返回"appName状态信息查询" |
|
|
|
+| data | APP相关信息| Json |状态：启动成功 App端口: port(9001) |
|
|
|
+
|
|
|
+e.g.
|
|
|
+```
|
|
|
+{
|
|
|
+ "code":"1",
|
|
|
+ "message":"appName状态信息查询成功",
|
|
|
+ "data":{
|
|
|
+ "status": "0", // 0:未启动 1:启动成功 2：启动失败(状态信息不正常，将错误信息返回到info字段?)
|
|
|
+ "port": "",
|
|
|
+ "db_port": "",
|
|
|
+ "info": ""
|
|
|
+ }
|
|
|
+}
|
|
|
+```
|
|
|
+
|
|
|
+
|
|
|
+### 客户已安装App状态查询接口（getAllAppInfo）？
|
|
|
+
|
|
|
+
|
|
|
+### 卸载客户已安装App（uninstallAllApp）？
|
|
|
+
|
|
|
+
|
|
|
+### 服务器状态查询接口（searchServer）
|
|
|
+
|
|
|
+#### 接口地址
|
|
|
+
|
|
|
+http://ip:port/searchServer
|
|
|
+
|
|
|
+#### 访问方式
|
|
|
+
|
|
|
+Http（get/post）
|
|
|
+同步/异步：同步
|
|
|
+
|
|
|
+
|
|
|
+#### 接口参数
|
|
|
+
|
|
|
+无
|
|
|
+
|
|
|
+#### 返回数据
|
|
|
+
|
|
|
+| 变量名 | 说明 | 类型 | 备注 |
|
|
|
+| ------------ | ------------ | ----- |----- |
|
|
|
+| code | 接口是否调用成功标志| str |"0":失败 "1":成功 |
|
|
|
+| message | 接口返回信息| str |如接口调用成功时返回"服务器状态信息查询成功" |
|
|
|
+| data | APP相关信息| Json |服务器各种信息，如cpu使用率，内存使用率，磁盘占有率 |
|
|
|
+
|
|
|
+e.g.
|
|
|
+```
|
|
|
+{
|
|
|
+ "code":"1",
|
|
|
+ "message":"服务器状态信息查询成功",
|
|
|
+ "data":{
|
|
|
+ "cpu": "10%",
|
|
|
+ "memory": "54%",
|
|
|
+ "hdd": "",
|
|
|
+ "risk": "3",
|
|
|
+ ...
|
|
|
+ "info": ""
|
|
|
+ }
|
|
|
+}
|
|
|
+```
|
qiaofeng1227