应用管理

应用管理

修改应用

基本信息

Path： /v1/apps/{name}

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
name

Body

名称	类型	是否必须	备注	其他信息
selector	string	非必须	node选择器
labels	object	非必须	标签
├─ key	string	必须
description	string	非必须	描述信息
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ labels	object	非必须	标签，map[string]string
├─ image	string	非必须	镜像，容器应用必须，函数应用的话后端会填充
├─ hostname	string	非必须	主机名
├─ replica	number	非必须	副本数量
├─ volumeMounts	object []	非必须	存储卷挂载列表，（后端）函数应用时默认会把选择的配置项 mount 到这，显示一条 mount, 由后端传回, 2. 对于函数列表，后端需要将其转化成一个 config，然后也 mount 进来	item 类型: object
├─ name	string	非必须	存储卷挂载名
├─ mountPath	string	非必须	挂载路径
├─ readOnly	boolean	非必须	是否只读
├─ immutable	boolean	非必须	用户是否可编辑
├─ ports	object []	非必须	端口映射列表	item 类型: object
├─ hostPort	integer	非必须	宿主机端口
├─ containerPort	integer	非必须	容器端口
├─ hostIP	string	非必须	宿主机IP
├─ protocol	string	非必须	协议
├─ devices	object []	非必须	设备挂载列表（暂不支持，可使用hostPath + privileged 实现）	item 类型: object
├─ devicePath	string	非必须	devicePath + “:”+policy
├─ policy	string	非必须	本字段暂时不支持；读写策略 r:只读；rw:读写, w:只写, m:mknod
├─ description	string	非必须	本字段暂时不支持
├─ args	string []	非必须	启动参数	item 类型: string
├─		非必须
├─ env	object []	非必须	环境变量	item 类型: object
├─ name	string	非必须	变量名
├─ value	string	非必须	变量值
├─ resources	object	非必须
├─ limits	object	非必须	可用资源，格式为map，key为cpu,memory等
├─ cpu	string	非必须	cpu可用量，整数或小数
├─ memory	string	非必须	内存可用量，value格式为 50M 或 50Mi 或 1024
├─ requests	object	非必须	请求资源，格式为map，key为cpu,memory等
├─ cpu	string	非必须	cpu请求量，整数或小数
├─ memory	string	非必须	内存请求量，value格式为 50M 或 50Mi 或 1024
├─ runtime	string	非必须	运行时，暂不支持
├─ restart	object	非必须	重启策略，暂不支持
├─ retry	object	非必须
├─ max	number	非必须
├─ policy	string	非必须	Always-总是； OnFailure - 失败；Never - 不重启
├─ backoff	object	非必须
├─ min	integer	必须
├─ max	integer	必须
├─ factor	number	必须
├─ functionConfig	object	非必须	函数配置
├─ name	string	非必须	函数配置项名称，函数应用必须
├─ runtime	string	非必须	函数配置项的运行时，函数应用必须
├─ functions	object []	非必须	函数列表	item 类型: object
├─ name	string	非必须	函数名称，函数应用必须
├─ handler	string	非必须	函数入口，函数应用必须
├─ codedir	string	非必须	代码目录，（PRD）函数入口文件位于”函数包”下的相对目录
├─ security	object	非必须	安全配置
├─ privileged	boolean	非必须	特权模式
├─ hostNetwork	boolean	非必须	宿主机网络
volumes	object []	非必须	存储卷列表	item 类型: object
├─ name	string	非必须	存储卷挂载名
├─ hostPath	object	非必须	宿主机映射
├─ path	string	非必须	宿主机路径
├─ config	object	非必须	配置项
├─ name	string	非必须	配置项名称
├─ secret	object	非必须	密钥配置项
├─ name	string	非必须	秘钥名称
registries	object []	非必须	镜像仓库凭证，map[string]{“name”:””}	item 类型: object
├─ name	string	非必须	凭证名称

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	应用名称
namespace	string	非必须	命名空间
selector	string	非必须	node选择器
labels	object	非必须	标签
├─ key	string	非必须
description	string	非必须	描述信息
version	string	非必须	版本
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ image	string	必须	镜像
├─ replica	number	非必须	副本数量
├─ volumeMounts	object	非必须	存储挂载列表
├─ name	string	非必须	存储卷挂载名
├─ mountPath	string	非必须	挂载路径
├─ readOnly	boolean	非必须	是否只读
├─ immutable	boolean	非必须	用户是否可编辑, 默认 false，为true时该 volumeMount 用户不可编辑
├─ restart	object	非必须	重启策略，暂不支持
├─ retry	object	非必须
├─ backoff	object	非必须
├─ resources	object	非必须	资源限制
├─ limits	object	非必须	可用资源，map
├─ cpu	string	非必须	可用cpu量
├─ memory	string	非必须	可用内存量
├─ requests	object	非必须	请求资源，map
├─ cpu	string	非必须	请求cpu量
├─ memory	string	非必须	请求内存量
├─ hostname	string	非必须	主机名
├─ ports	object []	非必须	端口配置列表	item 类型: object
├─ hostPort	integer	非必须	宿主机端口
├─ containerPort	integer	非必须	容器端口
├─ devices	object []	非必须	设备挂载列表（暂不支持）	item 类型: object
├─ devicePath	string	非必须	设备路径
├─ args	string []	非必须	启动参数	item 类型: string
├─		非必须
├─ env	object []	非必须	环境变量	item 类型: object
├─ name	string	非必须	变量名
├─ value	string	非必须	变量值
├─ functionConfig	object	非必须	函数配置
├─ name	string	非必须	函数配置项名称
├─ runtime	string	非必须	函数配置项的运行时
├─ functions	object []	非必须	函数列表	item 类型: object
├─ name	string	非必须	函数名
├─ handler	string	非必须	函数入口
├─ codedir	string	非必须	代码路径
├─ security	object	非必须	安全配置
├─ privileged	boolean	非必须	特权模式
├─ hostNetwork	boolean	非必须	宿主机网络
volumes	object []	非必须	存储卷列表	item 类型: object
├─ name	string	非必须	存储卷挂载名
├─ config	object	非必须	配置项
├─ name	string	非必须	配置项名
├─ hostPath	object	非必须	宿主机映射
├─ path	string	非必须	宿主机路径
registries	object []	非必须	镜像仓库凭证列表	item 类型: object
├─ name	string	非必须	凭证名称
├─ version	string	非必须	凭证版本
type	string	必须	应用类型：容器应用、函数应用, 分别对应 container 和 function

删除应用

基本信息

Path： /v1/apps/{name}

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
name		应用名称

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		是否删除成功

新建应用

基本信息

Path： /v1/apps

Method： POST

接口描述：
对于函数应用的，新建每个服务的时候将选中的配置项挂载到本服务里卷配置里
name: baetyl-function-code-配置项名称
类型：配置项
只读
路径： /var/lib/baetyl/code

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
from	否
base	否

Body

名称	类型	是否必须	备注	其他信息
name	string	必须	应用名称
selector	string	非必须	node选择器
labels	object	必须	标签
├─ key	string	必须
description	string	必须	描述信息
services	object []	必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ labels	object	非必须	标签，map[string]string
├─ image	string	非必须	镜像，容器应用必须，函数应用的话后端会填充
├─ hostname	string	非必须	主机名
├─ replica	number	非必须	副本数量
├─ volumeMounts	object []	非必须	存储卷挂载（后端）函数应用时默认会把选择的配置项 mount 到这，显示一条 mount, 由后端传回, 2. 对于函数列表，后端需要将其转化成一个 config，然后也 mount 进来	item 类型: object
├─ name	string	非必须	存储卷挂载名
├─ mountPath	string	非必须	挂载路径
├─ readOnly	boolean	非必须	是否只读
├─ immutable	boolean	非必须	用户是否可编辑, 默认 false，为true时该 volumeMount 用户不可编辑
├─ ports	object []	非必须	端口映射列表	item 类型: object
├─ hostPort	integer	非必须	宿主机端口
├─ containerPort	integer	非必须	容器端口
├─ hostIP	string	非必须	宿主机IP
├─ protocol	string	非必须	协议
├─ devices	object []	非必须	设备映射（暂不支持，可使用hostPath + privileged解决）	item 类型: object
├─ devicePath	string	非必须	devicePath + “:”+policy
├─ policy	string	非必须	本字段暂时不支持；读写策略 r:只读；rw:读写, w:只写, m:mknod
├─ description	string	非必须	本字段暂时不支持
├─ args	string []	非必须	启动参数	item 类型: string
├─		非必须
├─ env	object []	非必须	环境变量	item 类型: object
├─ name	string	非必须	变量名
├─ value	string	非必须	变量值
├─ resources	object	非必须	资源限制
├─ limits	object	非必须	可用资源，格式为map，key为cpu,memory等
├─ cpu	string	非必须	可用cpu量，整数或小数
├─ memory	string	非必须	可用内存量，value格式为 50M 或 50Mi 或 1024
├─ requests	object	非必须	请求资源，格式为map，key为cpu,memory等
├─ cpu	string	非必须	请求cpu量，整数或小数
├─ memory	string	非必须	请求内存量，value格式为 50M 或 50Mi 或 1024
├─ runtime	string	非必须	运行时（暂不支持）
├─ restart	object	非必须	重启策略（暂不支持）
├─ retry	object	非必须
├─ max	number	非必须
├─ policy	string	非必须	Always-总是； OnFailure - 失败；Never - 不重启
├─ backoff	object	非必须
├─ min	integer	必须
├─ max	integer	必须
├─ factor	number	必须
├─ functionConfig	object	非必须	函数配置
├─ name	string	非必须	函数配置项名称，函数应用必须
├─ runtime	string	非必须	函数配置项的运行时，函数应用必须
├─ functions	object []	非必须	函数列表，可以为空	item 类型: object
├─ name	string	非必须	函数名称，函数应用必须
├─ handler	string	非必须	函数入口，函数应用必须
├─ codedir	string	非必须	代码路径，（PRD）函数入口文件位于”函数包”下的相对目录
├─ security	object	非必须	安全配置
├─ privileged	boolean	非必须	特权模式
├─ hostNetwork	boolean	非必须	宿主机网络
volumes	object []	非必须	存储卷	item 类型: object
├─ name	string	必须	存储映射名称
├─ hostPath	object	非必须	宿主机映射
├─ path	string	非必须	宿主机路径
├─ config	object	非必须	配置项
├─ name	string	非必须	配置项名
├─ secret	object	必须	密钥配置项
├─ name	string	非必须	秘钥名
registries	object []	非必须	镜像仓库凭证，map[string]{“name”:””}	item 类型: object
├─ name	string	必须	凭证名
type	string	必须	应用类型：容器应用、函数应用，分别对应 container 和 function

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	应用名称
namespace	string	非必须	命名空间
selector	string	非必须	node选择器
description	string	非必须	描述信息
version	string	非必须	版本
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ image	string	非必须	镜像
├─ replica	number	非必须	副本数量
├─ volumeMounts	object	非必须	存储卷挂载列表
├─ name	string	非必须	存储卷挂载名
├─ mountPath	string	非必须	挂载路径
├─ readOnly	boolean	非必须	是否只读
├─ immutable	boolean	非必须	用户是否可编辑, 默认 false，为true时该 volumeMount 用户不可编辑
├─ restart	object	非必须	重启策略（暂不支持）
├─ retry	object	非必须
├─ backoff	object	非必须
├─ resources	object	非必须	资源限制
├─ limits	object	非必须	可用资源，map
├─ cpu	string	非必须	可用cpu
├─ memory	string	非必须	可用内存
├─ requests	object	非必须	请求资源，map
├─ cpu	string	非必须	请求cpu量
├─ memory	string	非必须	请求内存量
├─ hostname	string	非必须	主机名
├─ ports	object []	非必须	端口列表	item 类型: object
├─ hostPort	integer	非必须	宿主机端口
├─ containerPort	integer	非必须	容器端口
├─ devices	object []	非必须	设备挂载（暂不支持，可通过hostPath + privileged实现）	item 类型: object
├─ devicePath	string	非必须	设备路径
├─ args	string []	非必须	启动参数	item 类型: string
├─		非必须
├─ env	object []	非必须	环境变量	item 类型: object
├─ name	string	非必须	变量名
├─ value	string	非必须	变量值
├─ functionConfig	object	非必须	函数配置
├─ name	string	非必须	函数配置项名称
├─ runtime	string	非必须	函数配置项的运行时
├─ functions	object []	非必须	函数列表	item 类型: object
├─ name	string	非必须	函数名
├─ handler	string	非必须	函数入口
├─ codedir	string	非必须	代码路径
├─ security	object	非必须	安全配置
├─ privileged	boolean	非必须	特权模式
├─ hostNetwork	boolean	非必须	宿主机网络
volumes	object []	非必须	存储卷列表	item 类型: object
├─ name	string	必须	存储卷挂载名
├─ config	object	必须	配置项
├─ name	string	非必须	配置项名称
├─ hostPath	object	必须	宿主机映射
├─ path	string	非必须	宿主机路径
├─ secret	object	必须	秘钥
├─ name	string	必须	秘钥名
registries	object []	非必须	镜像仓库凭证	item 类型: object
├─ name	string	非必须	凭证名
type	string	必须	应用类型：容器应用、函数应用，分别对应 container 和 function
createTime	string	非必须	创建时间

查询应用

基本信息

Path： /v1/apps/{name}

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
name

Body

名称	类型	是否必须	备注	其他信息
name	string	必须
selector	string	非必须
labels	object	必须
├─ key	string	必须
description	string	必须
services	object []	必须		item 类型: object
├─ name	string	非必须
├─ labels	object	非必须	map[string]string
├─ image	string	非必须	容器应用必须
├─ hostname	string	非必须
├─ replica	number	非必须
├─ volumeMounts	object []	非必须		item 类型: object
├─ name	string	非必须
├─ mountPath	string	非必须
├─ readOnly	boolean	非必须
├─ ports	object []	非必须		item 类型: object
├─ hostPort	integer	非必须
├─ containerPort	integer	非必须
├─ hostIP	string	非必须
├─ protocol	string	非必须
├─ devices	object []	非必须		item 类型: object
├─ devicePath	string	非必须	devicePath + “:”+policy
├─ policy	string	非必须	本字段暂时不支持；读写策略 r:只读；rw:读写, w:只写, m:mknod
├─ description	string	非必须	本字段暂时不支持
├─ args	string []	非必须		item 类型: string
├─		非必须
├─ env	object []	非必须		item 类型: object
├─ name	string	非必须
├─ value	string	非必须
├─ resources	object	非必须
├─ limits	object	非必须	格式为map，key为cpu,memory等
├─ cpu	string	非必须	整数或小数
├─ memory	string	非必须	value格式为 50M 或 50Mi 或 1024
├─ requests	object	非必须	格式为map，key为cpu,memory等
├─ cpu	string	非必须	整数或小数
├─ memory	string	非必须	value格式为 50M 或 50Mi 或 1024
├─ runtime	string	非必须
├─ restart	object	非必须
├─ retry	object	非必须
├─ max	number	非必须
├─ policy	string	非必须	Always-总是； OnFailure - 失败；Never - 不重启
├─ backoff	object	非必须
├─ min	integer	必须
├─ max	integer	必须
├─ factor	number	必须
├─ function	object	非必须
├─ config	string	非必须	函数配置项名称，函数应用必须
├─ runtime	string	非必须	函数配置项的运行时，函数应用必须
├─ items	object []	非必须	函数应用时不为空	item 类型: object
├─ name	string	非必须	函数名称，函数应用必须
├─ handler	string	非必须	函数入口，函数应用必须
├─ path	string	非必须	容器目录，函数应用必须
volumes	object []	非必须		item 类型: object
├─ name	string	必须
├─ hostPath	object	非必须
├─ path	string	非必须
├─ config	object	非必须
├─ name	string	非必须
├─ secret	object	必须
├─ name		非必须
registries	object []	非必须	map[string]{“name”:””}	item 类型: object
├─ name	string	必须
security	object	非必须	安全配置
├─ privileged	boolean	非必须	开启特权模式
hostNetwork	boolean	非必须	host网络
type	string	必须	应用类型：容器应用、函数应用

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	应用名称
namespace	string	非必须	命名空间
select	string	非必须	node选择器
description	string	非必须	描述信息
version	string	非必须	版本
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	应用名称
├─ image	string	必须	镜像名称
├─ replica	number	非必须	副本数量
├─ volumeMounts	object []	非必须	存储卷挂载（后端）函数应用时默认会把选择的配置项 mount 到这，显示一条 mount, 由后端传回, 2. 对于函数列表，后端需要将其转化成一个 config，然后也 mount 进来	item 类型: object
├─ name	string	必须	存储卷挂载名
├─ mountPath	string	必须	挂载路径
├─ readOnly	boolean	非必须	是否只读
├─ immutable	boolean	非必须	用户是否可编辑, 默认 false，为true时该 volumeMount 用户不可编辑
├─ restart	object	非必须	重启策略（暂不支持）
├─ retry	object	非必须
├─ backoff	object	非必须
├─ resources	object	非必须	资源限制
├─ limits	object	非必须	可用资源
├─ cpu	string	非必须	可用cpu量
├─ memory	string	非必须	可用内存量
├─ requests	object	非必须	请求资源
├─ cpu	string	非必须	请求cpu量
├─ memory	string	非必须	请求内存量
├─ hostname	string	非必须	主机名
├─ ports	object []	非必须	端口配置列表	item 类型: object
├─ hostPort	integer	非必须	宿主机端口
├─ containerPort	integer	非必须	容器端口
├─ devices	object []	非必须	设备挂载列表（暂不支持，可以通过hostPath + privileged解决）	item 类型: object
├─ devicePath	string	非必须	设备路径
├─ args	string []	非必须	启动参数	item 类型: string
├─		非必须
├─ env	object []	非必须	环境变量	item 类型: object
├─ name	string	非必须	变量名
├─ value	string	非必须	变量值
├─ functionConfig	object	非必须	函数配置项
├─ name	string	非必须	函数配置项名称
├─ runtime	string	非必须	函数配置项的运行时
├─ functions	object []	非必须	函数列表	item 类型: object
├─ name	string	非必须	函数名
├─ handler	string	非必须	函数入口
├─ codedir	string	非必须	代码路径
├─ security	object	非必须	安全配置
├─ privileged	boolean	非必须	特权模式
├─ hostNetwork	boolean	非必须	宿主机网络
volumes	object []	非必须	存储卷列表	item 类型: object
├─ name	string	必须	存储卷挂载名
├─ config	object	必须	配置项
├─ name	string	非必须	配置项名称
├─ hostPath	object	必须	宿主机映射配置
├─ path	string	非必须	宿主机路径
├─ secret	object	必须	秘钥
├─ name	string	必须	秘钥名称
registries	object []	非必须	镜像仓库凭证	item 类型: object
├─ name	string	非必须	凭证名称
type	string	必须	应用类型：容器应用、函数应用
createTime	string	非必须	创建时间

罗列应用

基本信息

Path： /v1/apps

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
selector	否	abc=test	选择器
fieldSelector	否	metadata.name=test	域选择器
limit	否	10	查询数
continue	否	qwertyuhgfdsasdfghjkjd	是否继续查询

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	备注
name	string	非必须	应用名称
namespace	string	非必须	应用命名空间
selector	string	非必须	node选择器
description	string	非必须	描述信息
version	string	非必须	版本
createTime	string	非必须	创建时间
labels	object	非必须	标签
├─ key	string	必须
type	string	必须	应用类型：函数应用、容器应用，分别为 container 和 function