get_apps (Docker)
获取 Docker 应用商店中所有可安装的应用列表,共 289 个。每个应用的 env 和 field 字段定义了安装时需要的参数。
- 路由:
POST /mod/docker/com/get_apps/stype - 方法:POST
输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| data | Array<Object> | 应用列表 |
应用对象关键字段
| 字段 | 类型 | 描述 |
|---|---|---|
| appname | String | 应用标识名(传 create_app 的 app_name) |
| apptitle | String | 应用显示名称 |
| apptype | String | BuildWebsite(建站) / Database(数据库) / Storage(存储) 等 |
| appversion | Array | 可用版本列表,每项含 m_version(主版本) 和 s_version(子版本) |
| depend | Array | 依赖应用列表,安装前需先通过 get_dependence_apps 确认已安装 |
| env | Array<Object> | 安装参数定义,每项含 key(参数名)、type(类型)、desc(描述) |
| field | Array<Object> | UI 配置字段,每项含 attr(参数名)、name(显示名)、type(类型)、default(默认值) |
如何确定 create_app 的参数
- 从
appversion取m_version和s_version env数组中每个对象的key就是要传的参数名(如wordpress_port、mysql_database)field数组中每个对象的attr也是参数名(如allow_access、domain)
示例(WordPress)
{
"appname": "wordpress",
"apptitle": "WordPress",
"apptype": "BuildWebsite",
"appversion": [{"m_version": "6", "s_version": ["7.2", "7.1"]}],
"depend": [{"appname": ["mysql"], "apptype": "Database", "appversion": ["5", "8", "9"]}],
"env": [
{"key": "version", "type": "string", "desc": "版本号"},
{"key": "wordpress_port", "type": "port", "desc": "端口"}
],
"field": [
{"attr": "domain", "name": "域名", "type": "textarea"},
{"attr": "allow_access", "name": "允许外部访问", "type": "checkbox", "default": true}
]
}
安装 WordPress 需要先安装 MySQL 依赖。参数
wordpress_port、allow_access等均来自此接口返回。
相关接口
- create_app — 安装应用(参数来源于此接口)
- get_dependence_apps — 查询依赖安装状态