节点管理

查询节点关联的应用

基本信息

Path： /v1/nodes/{name}/apps

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	应用总数
listOptions	null	非必须	列表选项
items	object []	非必须	应用列表	item 类型: object
├─ name	string	必须	应用名称
├─ selector	string	必须	标签选择器
├─ namespace	string	必须	命名空间
├─ createTime	string	必须	创建时间

修改 core 配置（core 自升级）

基本信息

Path： /v1/nodes/{name}/core/configs

Method： PUT

接口描述：
~~baetyl 主模块升级接口，访问后会自动更新节点对应的core应用到最新版本baetyl镜像和配置~~

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		节点名称

Body

名称	类型	是否必须	备注
version	string	非必须	core 版本号
frequency	number	非必须	core 上报频率
apiport	number	非必须	core 边缘 API 端口

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	应用名称
namespace	string	非必须	命名空间
selector	string	非必须	node选择器
labels	object	非必须	标签
description	string	非必须	描述信息
version	string	非必须	版本
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ image	string	必须	镜像
├─ replica	number	非必须	副本数量，如果配置了宿主机端口，副本数不能大于1
├─ 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	非必须	服务所在宿主机上可以通过该端口访问服务，范围是0-65535
├─ containerPort	integer	非必须	服务对外暴露端口，其它baetyl启动的服务可以通过该端口访问服务，范围是0-65535
├─ hostIP	string	非必须	对外暴露端口绑定的IP
├─ protocol	string	非必须	可选TCP、UDP，默认TCP
├─ 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	非必须	宿主机路径
├─ secret	object	必须	秘钥
├─ name	string	必须	秘钥名
├─ certificate	object	必须	证书
├─ name	string	必须	证书名称
registries	object []	非必须	镜像仓库凭证列表	item 类型: object
├─ name	string	非必须	凭证名称
├─ version	string	非必须	凭证版本
type	string	必须	应用类型：容器应用、函数应用, 分别对应 container 和 function

创建节点

基本信息

Path： /v1/nodes

Method： POST

接口描述：
返回的report和desire不需要做检查

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
name	string	必须	节点名称
labels	object	非必须	map[string]string类型，例如 {"env":"test"}
annotations	object	非必须	map[string]string 用来保存品牌等属性信息
accelerator	string	非必须	为空或NVIDIA GPU
cluster	boolean	非必须	是单机还是集群环境
sysApps	string []	非必须	可选官方应用，支持 baetyl-function、baetyl-rule	item 类型: string
├─		非必须
description	string	非必须	描述信息

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	节点名称
namespace	string	非必须	命名空间
description	string	非必须	描述信息
accelerator	string	非必须	为空或NVIDIA GPU
sysApps	string []	非必须	可选官方应用，支持 baetyl-function、baetyl-rule	item 类型: string
├─		非必须
ready	boolean	非必须	节点是否已连接
createTime	string	非必须	创建时间
labels	object	非必须	标签
annotations	object	非必须	注解

删除节点

基本信息

Path： /v1/nodes/{name}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		节点名称

返回数据

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

批量查询节点

基本信息

Path： /v1/nodes?batch

Method： PUT

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
	string []	非必须		names	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	备注	其他信息
	object []	非必须		item 类型: object
├─ name	string	必须	节点名称
├─ namespace	string	非必须	命名空间
├─ description	string	非必须	描述信息
├─ ready	boolean	非必须	设备是否已连接
├─ createTime	string	非必须	创建时间
├─ labels	object	非必须	map[string]string类型，类似k8s labels，例如 {"env":"test"}
├─ annotations	object	非必须	map[string]string 用来保存例如品牌等属性信息
├─ report	object	非必须	节点上报信息
├─ time	string	非必须	上报时间
├─ node	object	非必须	节点信息
├─ hostname	string	非必须	主机名
├─ address	string	非必须	设备地址
├─ arch	string	非必须	设备架构
├─ kernelVer	string	非必须	核心版本
├─ os	string	非必须	系统
├─ containerRuntime	string	非必须	容器运行时
├─ machineID	string	非必须	设备ID
├─ bootID	string	非必须	启动ID
├─ systemUUID	string	非必须	系统uuid
├─ osImage	string	非必须	系统镜像
├─ nodestats	object	非必须	节点统计信息
├─ usage	object	非必须	资源使用量
├─ cpu	string	非必须	cpu使用量
├─ memory	string	非必须	内存使用量
├─ capacity	object	非必须	可用资源
├─ cpu	string	非必须	可用cpu
├─ memory	string	非必须	可用内存
├─ percent	object	非必须	使用率
├─ cpu	number	非必须	cpu使用率
├─ memory	number	非必须	内存使用率
├─ apps	object []	非必须	应用信息	item 类型: object
├─ name	string	非必须	应用名称
├─ version	string	非必须	应用版本
├─ sysapps	object []	非必须	同apps	item 类型: object
├─ name	string	非必须
├─ version	string	非必须
├─ appstats	object []	非必须	应用统计信息	item 类型: object
├─ name	string	非必须	应用名称
├─ version	string	非必须	应用版本
├─ status	string	非必须	应用运行状态，Running：已部署；Pending：部署中; Failed：任务执行失败
├─ cause	string	非必须	状态原因，status详细说明
├─ instances	object	非必须	副本统计信息
├─ key	object	非必须	副本名称
├─ name	string	非必须	副本名称
├─ serviceName	string	非必须	服务名称
├─ status	string	非必须	服务副本运行状态，Running：已部署；Pending：部署中; Succeeded: 任务已全部成功执行并退出; Failed：任务执行失败；Unknown: 未知
├─ cause	string	非必须	状态原因，status的详细说明
├─ createTime	string	非必须	创建时间
├─ usage	object	非必须	资源使用量
├─ cpu	string	非必须	cpu使用量
├─ memory	string	非必须	内存使用量
├─ sysappstats	object []	非必须	同appstats说明	item 类型: object
├─ name	string	非必须
├─ version	string	非必须
├─ status	string	非必须
├─ cause	string	非必须
├─ instances	object	非必须
├─ key	object	非必须
├─ name	string	非必须
├─ serviceName	string	非必须
├─ status	string	非必须
├─ cause	string	非必须
├─ createTime	string	非必须
├─ usage	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ core	object	非必须	边缘baetyl-core版本信息
├─ goVersion	string	非必须	go版本号
├─ binVersion	string	非必须	当前版本号
├─ gitRevision	string	非必须	git版本号
├─ total	number	必须	总数

更新节点属性

基本信息

Path： /v1/nodes/{name}/properties

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name

Body

名称	类型	是否必须	默认值	备注	其他信息
state	object	非必须
├─ desire	object	非必须		map[string]string, value必须为 string

返回数据

名称	类型	是否必须	备注
state	object	非必须
├─ report	object	非必须	map[string]string, value必须为string
├─ desire	object	非必须	map[string]string, value必须为string
metadata	object	非必须
├─ report	string	非必须	map[string]string， value是utc时间
├─ desire	string	非必须	map[string]string, value是utc时间

查询节点

基本信息

Path： /v1/nodes/{name}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name		节点名字

返回数据

名称	类型	是否必须	备注	其他信息
cluster	boolean	必须
ready	boolean	必须
mode	string	必须
appMode	string	非必须	应用模式，包括kube和native两个
sysApps	string []	非必须		item 类型: string
├─		非必须
annotations	object	非必须
├─ {{key}}	string	非必须
accelerator	string	非必须
name	string	非必须
attr	object	非必须
labels	object	非必须
├─ {{key}}	string	非必须
createTime	string	非必须
report	object	非必须
├─ time	string	非必须
├─ sysapps	object []	非必须		item 类型: object
├─ name	string	非必须
├─ version	string	非必须
├─ nodestats	object	非必须
├─ {{.name}}	object	非必须
├─ extension	object	非必须
├─ deviceNum	number	非必须
├─ totalMemory	string	非必须
├─ percent	number	非必须
├─ devices	object []	非必须		item 类型: object
├─ percent	number	非必须
├─ name	string	非必须
├─ temperature	number	非必须
├─ usedMemory	number	非必须
├─ powerUsage	number	非必须
├─ totalMemory	number	非必须
├─ usedMemory	string	非必须
├─ pidPressure	boolean	非必须
├─ diskPressure	boolean	非必须
├─ networkUnavailable	boolean	非必须
├─ percent	object	非必须
├─ memory	string	非必须
├─ gpu	string	非必须
├─ cpu	string	非必须
├─ capacity	object	非必须
├─ cpu	string	非必须
├─ gpu	string	非必须
├─ memory	string	非必须
├─ ready	boolean	非必须
├─ memoryPressure	boolean	非必须
├─ usage	object	非必须
├─ memory	string	非必须
├─ cpu	string	非必须
├─ gpu	string	非必须
├─ core	object	非必须
├─ binVersion	string	非必须
├─ goVersion	string	非必须
├─ gitRevision	string	非必须
├─ sysappstats	object []	非必须		item 类型: object
├─ name	string	必须
├─ version	string	必须
├─ status	string	必须
├─ instances	object	必须
├─ {{instanceName}}	object	非必须
├─ status	string	非必须
├─ serviceName	string	非必须
├─ createTime	string	非必须
├─ name	string	非必须
├─ usage	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ apps	object []	非必须		item 类型: object
├─ name	string	必须
├─ version	string	必须
├─ appstats	object []	非必须		item 类型: object
├─ status	string	必须
├─ name	string	必须
├─ version	string	必须
├─ node	object	非必须
├─ {{.name}}	object	非必须
├─ osImage	string	非必须
├─ address	string	非必须
├─ bootID	string	非必须
├─ systemUUID	string	非必须
├─ kernelVer	string	非必须
├─ role	string	非必须
├─ containerRuntime	string	非必须
├─ machineID	string	非必须
├─ os	string	非必须
├─ arch	string	非必须
├─ hostname	string	非必须
├─ labels	object	非必须	边缘集群节点上的标签
desire	object	非必须
├─ apps	string []	非必须		item 类型: string
├─		非必须
├─ sysapps	object []	非必须		item 类型: object
├─ name	string	必须
├─ version	string	必须
version	string	非必须
namespace	string	非必须
description	string	非必须

修改节点

基本信息

Path： /v1/nodes/{name}

Method： PUT

接口描述：
返回的report和desire不需要做检查

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		节点名称

Body

名称	类型	是否必须	备注	其他信息
labels	object	非必须	map[string]string类型，类似k8s labels，例如 {"env":"test"}
annotatins	object	非必须	map[string]string
description	string	非必须	描述信息
sysApps	string []	非必须	可选官方应用，支持 baetyl-function、baetyl-rule	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	节点名称
namespace	string	非必须	命名空间
description	string	非必须	描述信息
sysApps	string []	非必须	可选官方应用，支持 baetyl-function、baetyl-rule	item 类型: string
├─		非必须
ready	boolean	非必须	节点是否已连接
createTime	string	非必须	创建时间
labels	object	非必须	标签
annotations	object	非必须	注解

查询节点状态信息

基本信息

Path： /v1/nodes/{name}/stats

Method： GET

接口描述：
返回的desire不需要做检查

关于report字段下的node和nodestate说明：
因为现在baetyl开始支持集群下的部署了，所以node这里不再是一个边缘集群节点的信息
改为map，包含多个边缘集群节点的信息
key为节点的名字，value和以前一个节点的数据结构一样

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注	其他信息
namespace	string	非必须
name	string	非必须
version	string	非必须
createTime	string	非必须
accelerator	string	非必须	为空或nvidia
report	object	非必须
├─ time	string	非必须
├─ apps	object []	非必须		item 类型: object
├─ name	string	非必须
├─ version	string	非必须
├─ sysapps	object []	非必须		item 类型: object
├─ name	string	必须
├─ version	string	必须
├─ core	object	非必须
├─ goVersion	string	非必须
├─ binVersion	string	非必须
├─ gitRevision	string	非必须
├─ appstats	object []	非必须		item 类型: object
├─ name	string	非必须
├─ version	string	非必须
├─ status	string	非必须
├─ instances	object	非必须
├─ sysappstats	object []	非必须		item 类型: object
├─ name	string	必须
├─ version	string	必须
├─ status	string	必须
├─ instances	object	必须
├─ baetyl-broker-674dc9f479-65sdx	object	非必须
├─ name	string	非必须
├─ serviceName	string	非必须
├─ usage	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ status	string	非必须
├─ createTime	string	非必须
├─ baetyl-core-6ccf8495f-5lrg5	object	非必须
├─ name	string	非必须
├─ serviceName	string	非必须
├─ usage	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ status	string	非必须
├─ createTime	string	非必须
├─ baetyl-function-9788f6c6c-95m6x	object	非必须
├─ name	string	非必须
├─ serviceName	string	非必须
├─ usage	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ status	string	非必须
├─ createTime	string	非必须
├─ baetyl-init-59744d7d4d-bkbxm	object	非必须
├─ name	string	非必须
├─ serviceName	string	非必须
├─ usage	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ status	string	非必须
├─ createTime	string	非必须
├─ baetyl-rule-54f46698dc-djqcz	object	非必须
├─ name	string	非必须
├─ serviceName	string	非必须
├─ usage	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ status	string	非必须
├─ createTime	string	非必须
├─ node	object	非必须	map结构，key为集群一个节点的名字，value为这个节点对应的信息
├─ {{.name}}	object	非必须
├─ hostname	string	非必须
├─ address	string	非必须
├─ arch	string	非必须
├─ kernelVer	string	非必须
├─ os	string	非必须
├─ containerRuntime	string	非必须
├─ machineID	string	非必须
├─ bootID	string	非必须
├─ systemUUID	string	非必须
├─ osImage	string	非必须
├─ role	string	非必须
├─ labels	object	非必须
├─ nodestats	object	非必须	map结构，key为集群一个节点的名字，value为这个节点对应的状态信息
├─ {{.name}}	object	非必须
├─ ready	boolean	非必须
├─ diskPressure	boolean	非必须
├─ memoryPressure	boolean	非必须
├─ pidPressure	boolean	非必须
├─ networkUnavailable	boolean	非必须
├─ usage	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ gpu	string	非必须
├─ capacity	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ gpu	string	非必须
├─ percent	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ gpu	string	非必须
├─ extension	object	非必须
├─ deviceNum	number	非必须
├─ devices	object []	非必须		item 类型: object
├─ name	string	非必须
├─ usedMemory	number	非必须
├─ totalMemory	number	非必须
├─ percent	number	非必须
├─ powerUsage	number	非必须
├─ temperature	number	非必须
├─ usedMemory	string	非必须
├─ totalMemory	string	非必须
├─ percent	number	非必须
ready	boolean	非必须
mode	string	非必须
description	string	非必须
sysApps	string []	非必须		item 类型: string
├─		非必须
attr	object	非必须
├─ {{key}}	object	非必须
annotations	object	非必须
├─ {{key}}	string	非必须
cluster	boolean	非必须
labels	object	非必须
├─ {{key}}	string	非必须

罗列当前节点 core 版本号

基本信息

Path： /v1/nodes/{name}/core/versions

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	默认值	备注	其他信息
versions	string []	非必须		当前节点 core 版本号列表	item 类型: string
├─		非必须

罗列节点

基本信息

Path： /v1/nodes

Method： GET

接口描述：
1. 返回的report和desire不需要做检查
2. 只检查ready状态

请求参数

Query

参数名称	是否必须	备注
selector	否	标签查询
fieldSelector	否	属性查询
limit	否	分页限制
continue	否	分页继续token，由上一次分页查询返回
pageNo	否	查询页码
pageSize	否	每页数据数
name	否	模糊匹配名称
nodeSelector	否	子节点标签过滤

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	节点总数
selector	string	非必须	标签查询
fieldSelector	string	非必须	属性查询
limit	integer	非必须	分页限制
continue	string	非必须	分页继续token，由上一次分页查询返回
pageNo	number	非必须
pageSize	number	非必须
items	object []	非必须	节点列表	item 类型: object
├─ name	string	必须	节点名称
├─ namespace	string	必须	命名空间
├─ description	string	必须	描述信息
├─ ready	boolean	必须	节点是否已连接
├─ createTime	string	必须	创建时间
├─ labels	object	必须	标签
├─ annotations	object	非必须	注解，map[string]string 用来保存品牌等属性信息

获取 core 配置

基本信息

Path： /v1/nodes/{name}/core/configs

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注
version	string	非必须	core 版本
frequency	number	非必须	core 上报频率
apiport	number	非必须	core 边缘 API 端口

获取安装命令

基本信息

Path： /v1/nodes/:name/init

Method： GET

接口描述：
mode: 缺省/kube，返回kube模式安装命令，示例如下：
sudo mkdir -p -m 666 /var/lib/baetyl/host /var/lib/baetyl/object /var/lib/baetyl/store /var/lib/baetyl/log /var/lib/baetyl/run && curl -skfL '{{GetProperty "init-server-address"}}/v1/init/{{.InitApplyYaml}}?token={{.Token}}' -oinit.yml && kubectl delete clusterrolebinding baetyl-edge-system-rbac --ignore-not-found=true && kubectl delete ns baetyl-edge-system --ignore-not-found=true && kubectl apply -f init.yml

mode: native，返回进程模式安装命令，示例如下：
sudo mkdir -p -m 666 /var/lib/baetyl/host /var/lib/baetyl/object /var/lib/baetyl/store /var/lib/baetyl/log /var/lib/baetyl/run && baetyl delete && baetyl apply -f '{{GetProperty "init-server-address"}}/v1/init/baetyl-init-apply.json?token={{.Token}}' --skip-verify=true

请求参数

路径参数

参数名称	示例	备注
name		节点名称

Query

参数名称	是否必须	示例	备注
mode	否		缺省或kube为kube安装命令
mode	否		进程模式安装命令

返回数据

名称	类型	是否必须	默认值	备注	其他信息
cmd	string	必须		安装命令

获取节点属性

基本信息

Path： /v1/nodes/{name}/properties

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注
state	object	非必须
├─ report	object	非必须	map[string]string
├─ desire	object	非必须	map[string]string
metadata	object	非必须
├─ report	object	非必须	map[string]string，value是utc时间
├─ desire	object	非必须	map[string]string，value是utc时间

证书管理

修改证书

基本信息

Path： /v1/certificates/{name}

Method： PUT

接口描述：
后端更新的时候，先查询证书，然后如果 cert 或者 key字段前端传值得话，就替换刚查询到的对应的字段，然后做 update

请求参数

Headers

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

路径参数

参数名称	示例	备注
name

Body

名称	类型	是否必须	备注
description	string	非必须
data	object	非必须
├─ certificate	string	非必须	公钥
├─ key	string	非必须	私钥

返回数据

名称	类型	是否必须	备注
name	string	非必须
signatureAlgorithm	string	非必须
effectiveTime	string	非必须
expiredTime	string	非必须
serialNumber	number	非必须
issuer	string	非必须
fingerPrint	string	非必须
description	string	非必须
namespace	string	非必须
createTime	string	非必须
updateTime	string	非必须
version	string	非必须
data	object	非必须
├─ certificate	string	非必须	公钥

创建证书

基本信息

Path： /v1/certificates

Method： POST

接口描述：
前端不做证书公钥/私钥是否匹配的校验，由后端校验（参考 rancher）
前端应：
1、首先实现文本的模式
2、在实现1以后，再考虑上传证书文件（是否做，姜婷确认，如果做，通知陈胜补充上传接口）
3、证书内容做 trim 操作，去除首尾的空格
4、注意不要破坏证书的格式，也即文本模式即可

请求参数

Headers

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

Body

名称	类型	是否必须	备注
name	string	必须
description	string	非必须
data	object	非必须
├─ certificate	string	非必须	公钥
├─ key	string	非必须	私钥

返回数据

名称	类型	是否必须	备注
name	string	非必须
signatureAlgorithm	string	非必须
effectiveTime	string	非必须
expiredTime	string	非必须
serialNumber	number	非必须
issuer	string	非必须
fingerPrint	string	非必须
description	string	非必须
namespace	string	非必须
createTime	string	非必须
updateTime	string	非必须
version	string	非必须
data	object	非必须
├─ certificate	string	非必须	公钥

删除证书

基本信息

Path： /v1/certificates/{name}

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
name

返回数据

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

查询证书

基本信息

Path： /v1/certificates/{name}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注
name	string	非必须
signatureAlgorithm	string	非必须
effectiveTime	string	非必须
expiredTime	string	非必须
serialNumber	number	非必须
issuer	string	非必须
fingerPrint	string	非必须
description	string	非必须
namespace	string	非必须
createTime	string	非必须
updateTime	string	非必须
version	string	非必须
data	object	非必须
├─ certificate	string	非必须	公钥

查询证书关联的应用

基本信息

Path： /v1/certificates/{name}/apps

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
listOptions	object	非必须	查询选项
├─ selector	string	非必须	标签选择器
├─ fieldSelector	string	非必须	字段选择器
├─ limit	integer	非必须	限制条数
├─ continue	string	非必须
items	object []	非必须	应用列表	item 类型: object
├─ name	string	非必须	应用名称
├─ labels	object	非必须	应用标签对键值对
├─ description	string	非必须	应用描述
├─ namespace	string	非必须	应用命名空间
├─ createTime	string	非必须	创建时间
├─ version	string	非必须	版本
├─ type	string	非必须	应用类型
├─ selector	string	非必须	应用匹配节点标签

罗列证书

基本信息

Path： /v1/certificates

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
fieldSelector	否	字段选择器
selector	否	标签选择器
limit	否	限制条数
continue	否
pageNo	否	页码
pageSize	否	每页数据数
name	否	模糊匹配名称

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
selector	string	非必须	标签选择器
fieldSelector	string	非必须	字段选择器
limit	integer	非必须	限制条数
continue	string	非必须
pageNo	number	非必须
pageSize	number	非必须
items	object []	非必须	列表	item 类型: object
├─ name	string	非必须	名称
├─ effectiveTime	string	非必须	生效时间
├─ expiredTime	string	非必须	过期时间
├─ description	string	非必须	描述

应用管理

修改应用

基本信息

Path： /v1/apps/{name}

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name

Body

名称	类型	是否必须	备注	其他信息
selector	string	非必须	node选择器
nodeSelector	string	非必须	边缘集群中node选择器
labels	object	非必须	标签
description	string	非必须	描述信息
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ labels	object	非必须	标签，map[string]string
├─ image	string	非必须	镜像，容器应用必须，函数应用的话后端会填充
├─ hostname	string	非必须	主机名
├─ type	string	非必须	deployment/daemonset
├─ replica	number	非必须	副本数量，如果配置了宿主机端口，副本数不能大于1
├─ volumeMounts	object []	非必须	存储卷挂载列表，（后端）函数应用时默认会把选择的配置项 mount 到这，显示一条 mount, 由后端传回, 2. 对于函数列表，后端需要将其转化成一个 config，然后也 mount 进来	item 类型: object
├─ name	string	非必须	存储卷挂载名
├─ mountPath	string	非必须	挂载路径
├─ readOnly	boolean	非必须	是否只读
├─ immutable	boolean	非必须	用户是否可编辑
├─ ports	object []	非必须	端口映射列表	item 类型: object
├─ hostPort	integer	非必须	服务所在宿主机上可以通过该端口访问服务，范围是0-65535
├─ containerPort	integer	非必须	服务对外暴露端口，其它baetyl启动的服务可以通过该端口访问服务，范围是0-65535
├─ hostIP	string	非必须	对外暴露端口绑定的IP
├─ protocol	string	非必须	可选TCP、UDP，默认TCP
├─ 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
├─ baidu.com/vcuda-memory	string	非必须	显存可用量，单位是256Mi(MB)
├─ 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	非必须	宿主机网络
├─ programConfig	string	非必须	程序包
volumes	object []	非必须	存储卷	item 类型: object
├─ name	string	必须	存储映射名称
├─ hostPath	object	非必须	宿主机映射
├─ path	string	非必须	宿主机路径
├─ config	object	非必须	配置项
├─ name	string	非必须	配置项名
├─ secret	object	非必须	密钥配置项
├─ name	string	非必须	秘钥名
├─ certificate	object	非必须	证书
├─ name	string	必须	证书名称
registries	object []	非必须	镜像仓库凭证，map[string]{"name":""}	item 类型: object
├─ name	string	非必须	凭证名称

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	应用名称
namespace	string	非必须	命名空间
selector	string	非必须	node选择器
nodeSelector	string	非必须	边缘集群中node选择器
labels	object	非必须	标签
description	string	非必须	描述信息
version	string	非必须	版本
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ image	string	必须	镜像
├─ replica	number	非必须	副本数量，如果配置了宿主机端口，副本数不能大于1
├─ 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	非必须	可用内存量
├─ baidu.com/vcuda-memory	string	非必须	单位是256Mi（MB）
├─ requests	object	非必须	请求资源，map
├─ cpu	string	非必须	请求cpu量
├─ memory	string	非必须	请求内存量
├─ hostname	string	非必须	主机名
├─ ports	object []	非必须	端口配置列表	item 类型: object
├─ hostPort	integer	非必须	服务所在宿主机上可以通过该端口访问服务，范围是0-65535
├─ containerPort	integer	非必须	服务对外暴露端口，其它baetyl启动的服务可以通过该端口访问服务，范围是0-65535
├─ hostIP	string	非必须	对外暴露端口绑定的IP
├─ protocol	string	非必须	可选TCP、UDP，默认TCP
├─ 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	非必须	宿主机网络
├─ programConfig	string	非必须	程序包
volumes	object []	非必须	存储卷列表	item 类型: object
├─ name	string	必须	存储卷挂载名
├─ config	object	必须	配置项
├─ name	string	非必须	配置项名称
├─ hostPath	object	必须	宿主机映射
├─ path	string	非必须	宿主机路径
├─ secret	object	必须	秘钥
├─ name	string	必须	秘钥名
├─ certificate	object	必须	证书
├─ name	string	必须	证书名称
registries	object []	非必须	镜像仓库凭证列表	item 类型: object
├─ name	string	非必须	凭证名称
├─ version	string	非必须	凭证版本
type	string	必须	应用类型：容器应用、函数应用, 分别对应 container 和 function
mode	string	必须	应用模式

删除应用

基本信息

Path： /v1/apps/{name}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

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

Body

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

返回数据

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

应用复制

基本信息

Path： /v1/apps/:name

Method： POST

接口描述：
newicafe.baidu.com/v5/issue/baetyl-406/show
应用复制的时候，应用关联的configmap/secret由用户选择是否进行真复制，默认不复制只做关联，进行复制的需要提供，base的配置和新的配置名称(必选)、标签、描述信息

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		要复制的app名字

Body

名称	类型	是否必须	备注	其他信息
name	string	必须	新的app名字
labels	object	非必须	kv 键值对
description	string	非必须
configs	object []	非必须	要替换的配置列表	item 类型: object
├─ {:base_config_name}	object	必须	待替换的configs
├─ name	string	必须	新的config名字
├─ labels	object	非必须
├─ description	string	非必须
secrets	object []	非必须	要替换的secret列表	item 类型: object
├─ {:base_secret_name}	object	必须	待替换的secret
├─ name	string	必须	新的secret名字
├─ labels	object	非必须
├─ description	string	非必须

返回数据

名称	类型	是否必须	备注	其他信息
type	string	非必须
name	string	非必须
namespace	string	非必须
selector	string	非必须
nodeSelector	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	非必须
├─ restart	object	必须
├─ resources	object	必须
├─ limits	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ requests	object	非必须
├─ cpu	string	非必须
├─ memory	string	非必须
├─ hostname	string	必须
├─ ports	object []	必须		item 类型: object
├─ hostPort	number	必须
├─ containerPort	number	必须
├─ hostIP	string	必须
├─ protocol	string	必须
├─ 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	非必须
├─ secret	object	必须
├─ name	string	非必须
├─ certificate	object	必须
├─ name	string	非必须
registries	object []	非必须		item 类型: object
├─ name	string	必须
createTime	string	非必须

新建应用

基本信息

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选择器，类似k8s label selector
nodeSelector	string	非必须	在边缘侧使用的比啊你去拿选择器
labels	object	必须	map[string]string类型，类似k8s labels，例如 {"env":"test"}
description	string	必须	描述信息
services	object []	必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ labels	object	非必须	标签，map[string]string
├─ type	string	非必须	deployment(默认)/daemonset
├─ image	string	非必须	镜像，容器应用必须，函数应用的话后端会填充
├─ hostname	string	非必须	主机名
├─ replica	number	非必须	副本数量，如果配置了宿主机端口，副本数不能大于1
├─ 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	非必须	服务所在宿主机上可以通过该端口访问服务，范围是0-65535
├─ containerPort	integer	非必须	服务对外暴露端口，其它baetyl启动的服务可以通过该端口访问服务，范围是0-65535
├─ hostIP	string	非必须	对外暴露端口绑定的IP
├─ protocol	string	非必须	可选TCP、UDP，默认TCP
├─ 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
├─ baidu.com/vcuda-memory	string	非必须	单位是256Mi(MB)
├─ 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	非必须	宿主机网络
├─ programConfig	string	非必须	程序包配置项名称
volumes	object []	非必须	存储卷	item 类型: object
├─ name	string	必须	存储映射名称
├─ hostPath	object	非必须	宿主机映射
├─ path	string	非必须	宿主机路径
├─ config	object	非必须	配置项
├─ name	string	非必须	配置项名
├─ secret	object	非必须	密钥配置项
├─ name	string	非必须	秘钥名
├─ certificate	object	非必须	证书
├─ name	string	必须	证书名称
registries	object []	非必须	镜像仓库凭证，map[string]{"name":""}	item 类型: object
├─ name	string	必须	凭证名
type	string	必须	应用类型：容器应用、函数应用，分别对应 container 和 function
mode	string	必须	应用模式：Kube模式、进程模式，分别对应"kube"、"native"

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	应用名称
namespace	string	非必须	命名空间
selector	string	非必须	node选择器
nodeSelector	string	非必须	边缘集群中node选择器
description	string	非必须	描述信息
version	string	非必须	版本
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	服务名称
├─ image	string	非必须	镜像
├─ replica	number	非必须	副本数量，如果配置了宿主机端口，副本数不能大于1
├─ type	string	非必须	deployment/daemonset
├─ 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	非必须	可用内存
├─ baidu.com/vcuda-memory	string	非必须	单位是256Mi(MB)
├─ requests	object	非必须	请求资源，map
├─ cpu	string	非必须	请求cpu量
├─ memory	string	非必须	请求内存量
├─ hostname	string	非必须	主机名
├─ ports	object []	非必须	端口列表	item 类型: object
├─ hostPort	integer	非必须	服务所在宿主机上可以通过该端口访问服务，范围是0-65535
├─ containerPort	integer	非必须	服务对外暴露端口，其它baetyl启动的服务可以通过该端口访问服务，范围是0-65535
├─ hostIP	string	非必须	对外暴露端口绑定的IP
├─ protocol	string	非必须	可选TCP、UDP，默认TCP
├─ 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	非必须	宿主机网络
├─ programConfig	string	非必须	程序包
volumes	object []	非必须	存储卷列表	item 类型: object
├─ name	string	必须	存储卷挂载名
├─ config	object	必须	配置项
├─ name	string	非必须	配置项名称
├─ hostPath	object	必须	宿主机映射
├─ path	string	非必须	宿主机路径
├─ secret	object	必须	秘钥
├─ name	string	必须	秘钥名
├─ certificate	object	必须	证书
├─ name	string	必须	证书名称
registries	object []	非必须	镜像仓库凭证	item 类型: object
├─ name	string	非必须	凭证名
type	string	必须	应用类型：容器应用、函数应用，分别对应 container 和 function
mode	string	必须	应用模式
createTime	string	非必须	创建时间

查询应用

基本信息

Path： /v1/apps/{name}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	应用名称
namespace	string	非必须	命名空间
selector	string	非必须	node选择器
nodeSelector	string	非必须	边缘集群中node选择器
description	string	非必须	描述信息
version	string	非必须	版本
services	object []	非必须	服务列表	item 类型: object
├─ name	string	非必须	应用名称
├─ image	string	必须	镜像名称
├─ replica	number	非必须	副本数量，如果配置了宿主机端口，副本数不能大于1
├─ type	string	非必须	deployment/daemonset
├─ 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	非必须	可用内存量
├─ baidu.com/vcuda-memory	string	非必须	单位是256Mi(MB)
├─ requests	object	非必须	请求资源
├─ cpu	string	非必须	请求cpu量
├─ memory	string	非必须	请求内存量
├─ hostname	string	非必须	主机名
├─ ports	object []	非必须	端口配置列表	item 类型: object
├─ hostPort	integer	非必须	服务所在宿主机上可以通过该端口访问服务，范围是0-65535
├─ containerPort	integer	非必须	服务对外暴露端口，其它baetyl启动的服务可以通过该端口访问服务，范围是0-65535
├─ hostIP	string	非必须	对外暴露端口绑定的IP
├─ protocol	string	非必须	可选TCP、UDP，默认TCP
├─ 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	非必须	宿主机网络
├─ programConfig	string	非必须	程序包
volumes	object []	非必须	存储卷列表	item 类型: object
├─ name	string	必须	存储卷挂载名
├─ config	object	必须	配置项
├─ name	string	非必须	配置项名称
├─ hostPath	object	必须	宿主机映射
├─ path	string	非必须	宿主机路径
├─ secret	object	必须	秘钥
├─ name	string	必须	秘钥名
├─ certificate	object	必须	证书
├─ name	string	必须	证书名称
registries	object []	非必须	镜像仓库凭证	item 类型: object
├─ name	string	非必须	凭证名称
type	string	必须	应用类型：容器应用、函数应用
mode	string	必须	应用模式
createTime	string	非必须	创建时间

罗列应用

基本信息

Path： /v1/apps

Method： GET

接口描述：

请求参数

Headers

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

Query

参数名称	是否必须	备注
selector	否	选择器
fieldSelector	否	域选择器
limit	否	查询数
continue	否	是否继续查询
pageNo	否	页码
pageSize	否	每页数据数
name	否	模糊匹配名称

返回数据

名称	类型	是否必须	备注	其他信息
selector	string	非必须	总数量
total	string	非必须	node选择器
fieldSelector	string	非必须	域选择器
limit	string	非必须	查询数
continue	string	非必须	是否继续查询
pageNo	number	非必须	页码
pageSize	number	非必须	每页数据数
name	string	非必须	模糊匹配名称
items	object []	非必须	列表	item 类型: object
├─ name	string	非必须
├─ namespace	string	非必须
├─ labels	object	非必须
├─ selector	string	非必须
├─ nodeSelector	string	非必须
├─ version	string	非必须
├─ type	string	非必须
├─ mode	string	非必须
├─ description	string	非必须
├─ system	string	非必须
├─ createTime	string	非必须

获取系统应用的密文

基本信息

Path： /v1/apps/{name}/secrets

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
listOptions	object	非必须	查询选项
├─ selector	string	非必须	标签选择器
├─ fieldSelector	string	非必须	字段选择器
├─ limit	integer	非必须	限制条数
├─ continue	string	非必须
items	object []	非必须	列表	item 类型: object
├─ name	string	非必须	密文名称
├─ namespace	string	非必须	命名空间
├─ createTime	string	非必须	创建时间
├─ updateTime	string	非必须	更新时间
├─ description	string	非必须	描述
├─ version	string	非必须	版本

获取系统应用的证书

基本信息

Path： /v1/apps/{name}/certificates

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
listOptions	object	非必须	查询选项
├─ selector	string	非必须	标签选择器
├─ fieldSelector	string	非必须	字段选择器
├─ limit	integer	非必须	限制条数
├─ continue	string	非必须
items	object []	非必须	列表	item 类型: object
├─ name	string	非必须	名称
├─ effectiveTime	string	非必须	生效时间
├─ expiredTime	string	非必须	过期时间
├─ description	string	非必须	描述

获取系统应用的配置项

基本信息

Path： /v1/apps/{name}/configs

Method： GET

接口描述：

请求参数

路径参数

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

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
listOptions	object	非必须	查询选项
├─ selector	string	非必须	标签选择器
├─ fieldSelector	string	非必须	字段选择器
├─ limit	integer	非必须	限制条数
├─ continue	string	非必须
items	object []	非必须	配置项列表	item 类型: object
├─ name	string	非必须	配置项名称
├─ labels	object	非必须	配置项标签对
├─ description	string	非必须	描述
├─ namespace	string	非必须	命名空间
├─ createTime	string	非必须	创建时间
├─ updateTime	string	非必须	更新时间
├─ version	string	非必须	版本

获取系统应用的镜像凭证

基本信息

Path： /v1/apps/{name}/registries

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
listOptions	object	非必须	查询选项
├─ selector	string	非必须	标签选择器
├─ fieldSelector	string	非必须	字段选择器
├─ limit	integer	非必须	限制条数
├─ continue	string	非必须
items	object []	非必须	列表	item 类型: object
├─ name	string	非必须	名称
├─ namespace	string	非必须	命名空间
├─ address	string	非必须	镜像地址
├─ username	string	非必须	用户名
├─ createTime	string	非必须	创建时间
├─ updateTime	string	非必须	更新时间
├─ description	string	非必须	描述
├─ version	string	非必须	版本

配置管理

全量 secrets 查询

基本信息

Path： /v1/baetylsecrets/{name}

Method： GET

接口描述：
此接口用于查询全量 secret，包括"密文"，"证书"，"镜像凭证"

请求参数

路径参数

参数名称	示例	备注
name		baetyl secret 名称

返回数据

名称	类型	是否必须	备注
name	string	非必须	名称
namespace	string	非必须	命名空间
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本

配置项管理

修改配置项

基本信息

Path： /v1/configs/{name}

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		配置项名称

Body

名称	类型	是否必须	备注	其他信息
labels	object	非必须	标签对对于函数配置项，使用 baetyl-function: runtime 标识
data	object []	非必须	配置项内容	item 类型: object
├─ key	string	非必须	文件名
├─ value	object	非必须	文件信息
description	string	非必须	描述

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	名称
labels	object	非必须	标签对对于函数配置项，使用 baetyl-function: runtime 标识
data	object []	非必须	配置项内容	item 类型: object
├─ key	string	非必须	文件名
├─ value	object	非必须	文件信息
description	string	非必须	描述
namespace	string	非必须	命名空间
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
version	string	非必须	版本

创建配置项

基本信息

Path： /v1/configs

Method： POST

接口描述：
对于配置项数据 data 字段，key 为文件名，value 为文件信息，根据 value 中的 "type" 字段分为 kv类型，文件类型，函数类型：

kv 类型：

{
    "type": "kv",
    "value":"content"
}

文件类型：

{
    "type": "object",
    "source":"awss3",
    "account": "current",  // current 表示当前用户, other 表示其他用户
    "url": "[http://download.com/url](http://download.com/url)", // 只有是外部公开链接的时候，此字段才有，表示公开链接的url
    "endpoint":"[http://xx.xx.com](http://xx.xx.com)",
    "addressFormat": "pathStyle", // 对象存储访问方式, pathStyle为endpoint/bucket, virtualHost为bucket.endpoint/
    "bucket":"baetyl",
    "object":"func.zip",
    "unpack":"zip",
    "ak":"xx",
    "sk":"xx",
    "md5": "xxxx"
}

注： bos, awss3，http 对应的枚举值分别是 baidubos, awss3，http，同时前段在展示 http 类型时（未点开弹框），只显示 url, md5 即可

函数类型：

{
    "type": "function",
    "function":"process",
    "version":"1",
    "runtime":"python36",
    "handler": "index.handler",
    "bucket":"baetyl-cloud-xx",
    "object":"process.zip",
    "source":"baidubos",
    "unpack": "zip"
}

如果是程序包类型配置项，那么：
1. 前端在标签中添加 baetyl-config-type: baetyl-program，不可编辑
2. 使用文件类型存储数据，并且key是平台信息，key的枚举值有
darwin-amd64 （mac amd64 平台）
linux-amd64 （linux amd64 平台）
linux-arm64-v8 （linux arm64 平台）
linux-arm-v7 （linux armv7 平台）

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
name	string	必须	名称
labels	object	非必须	标签对对于函数配置项，使用 baetyl-function: runtime 标识
data	object []	非必须	配置项数据	item 类型: object
├─ key	string	非必须	文件名
├─ value	object	非必须	文件信息
description	string	非必须	描述

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	名称
labels	object	非必须	标签对对于函数配置项，使用 baetyl-function: runtime 标识
data	object []	非必须	配置项数据	item 类型: object
├─ key	string	非必须	文件名
├─ value	object	非必须	文件信息
description	string	非必须	描述
namespace	string	非必须	命名空间
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
version	string	非必须	版本

删除配置项

基本信息

Path： /v1/configs/{name}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		配置项名称

返回数据

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

查询配置项

基本信息

Path： /v1/configs/{name}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name		配置项名称

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须	名称
labels	object	非必须	标签对对于函数配置项，使用 baetyl-function: runtime 标识
data	object []	非必须	配置项数据	item 类型: object
├─ key	string	非必须	文件名
├─ value	object	非必须	文件信息
description	string	非必须	描述
namespace	string	非必须	命名空间
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
version	string	非必须	版本

查询配置项关联的应用

基本信息

Path： /v1/configs/{name}/apps

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name		配置项名称

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
listOptions	object	非必须	查询选项
├─ selector	string	非必须	标签选择器
├─ fieldSelector	string	非必须	字段选择器
├─ limit	integer	非必须	限制条数
├─ continue	string	非必须
items	object []	非必须	应用列表	item 类型: object
├─ name	string	非必须	应用名称
├─ labels	object	非必须	应用标签对键值对
├─ description	string	非必须	应用描述
├─ namespace	string	非必须	应用命名空间
├─ createTime	string	非必须	创建时间
├─ version	string	非必须	版本
├─ type	string	非必须	应用类型
├─ selector	string	非必须	应用匹配节点标签

罗列配置项

基本信息

Path： /v1/configs

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
selector	否	对于函数配置项查询：/v1/configs?selector=baetyl-function
fieldSelector	否	标签选择
limit	否	限制条数
continue	否
pageNo	否	页码
pageSize	否	每页数据数
name	否	模糊匹配名称

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
selector	string	非必须	标签选择器
fieldSelector	string	非必须	字段选择器
limit	integer	非必须	限制条数
continue	string	非必须
pageNo	number	非必须
pageSize	number	非必须
items	object []	非必须	配置项列表	item 类型: object
├─ name	string	非必须	配置项名称
├─ labels	object	非必须	配置项标签对
├─ description	string	非必须	描述
├─ namespace	string	非必须	命名空间
├─ createTime	string	非必须	创建时间
├─ updateTime	string	非必须	更新时间
├─ version	string	非必须	版本

配置复制

基本信息

Path： /v1/configs/:name

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		待复制的配置名称

Body

名称	类型	是否必须	备注
name	string	必须	新的config名称
labels	object	非必须	kv 键值对
description	string	非必须

返回数据

名称	类型	是否必须	备注	其他信息
name	string	非必须
data	object []	非必须	kv 键值对	item 类型: object
├─ key	string	必须
description	string	非必须
namespace	string	非必须
createTime	string	非必须
updateTime	string	非必须
version	string	非必须

密文管理

修改密文

基本信息

Path： /v1/secrets/{name}

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		密文名称

Body

名称	类型	是否必须	默认值	备注	其他信息
data	object	非必须		密文数据键值对
description	string	非必须		描述

返回数据

名称	类型	是否必须	备注
name	string	非必须	名称
namespace	string	非必须	命名空间
data	object	非必须	密文数据键值对
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本

创建密文

基本信息

Path： /v1/secrets

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
name	string	必须	名称
data	object	非必须	密文数据键值对
description	string	非必须	描述

返回数据

名称	类型	是否必须	备注
name	string	非必须	名称
namespace	string	非必须	命名空间
data	object	非必须	密文数据键值对
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本

删除密文

基本信息

Path： /v1/secrets/{name}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		密文名称

返回数据

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

密文复制

基本信息

Path： /v1/secrets/:name

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		待复制密文名称

Body

名称	类型	是否必须	备注
name	string	必须	新的config名称
labels	object	非必须
description	string	非必须

返回数据

名称	类型	是否必须	备注
name	string	非必须	密文名称
namespace	string	非必须	命名空空
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本信息
data	object	非必须	密文键值对

查询密文

基本信息

Path： /v1/secrets/{name}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name		密文名称

返回数据

名称	类型	是否必须	备注
name	string	非必须	名称
namespace	string	非必须	命名空间
data	object	非必须	密文数据键值对
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本

查询密文关联的应用

基本信息

Path： /v1/secrets/{name}/apps

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name		密文名称

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
listOptions	object	非必须	查询选项
├─ selector	string	非必须	标签选择器
├─ fieldSelector	string	非必须	字段选择器
├─ limit	integer	非必须	限制条数
├─ continue	string	非必须
items	object []	非必须	应用列表	item 类型: object
├─ name	string	非必须	应用名称
├─ labels	object	非必须	应用标签对键值对
├─ description	string	非必须	应用描述
├─ namespace	string	非必须	应用命名空间
├─ createTime	string	非必须	创建时间
├─ version	string	非必须	版本
├─ type	string	非必须	应用类型
├─ selector	string	非必须	应用匹配节点标签

罗列密文

基本信息

Path： /v1/secrets

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
fieldSelector	否	字段选择器
selector	否	标签选择器
limit	否	限制条数
continue	否
pageNo	否	页码
pageSize	否	每页数据数
name	否	模糊匹配名称

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
selector	string	非必须	标签选择器
fieldSelector	string	非必须	字段选择器
limit	integer	非必须	限制条数
continue	string	非必须
pageNo	number	非必须
pageSize	number	非必须
items	object []	非必须	列表	item 类型: object
├─ name	string	非必须	密文名称
├─ namespace	string	非必须	命名空间
├─ createTime	string	非必须	创建时间
├─ updateTime	string	非必须	更新时间
├─ description	string	非必须	描述
├─ version	string	非必须	版本

镜像仓库凭证管理

修改描述

基本信息

Path： /v1/registries/{name}

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		凭证名称

Body

名称	类型	是否必须	默认值	备注	其他信息
description	string	非必须		描述

返回数据

名称	类型	是否必须	备注
name	string	非必须	名称
namespace	string	非必须	命名空间
address	string	非必须	镜像仓库地址
username	string	非必须	用户名
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本

创建凭证

基本信息

Path： /v1/registries

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
name	string	非必须	名称
description	string	非必须	描述
address	string	非必须	镜像仓库地址
username	string	非必须	用户名
password	string	非必须	密码

返回数据

名称	类型	是否必须	备注
name	string	非必须	名称
namespace	string	非必须	命名空间
address	string	非必须	镜像仓库地址
username	string	非必须	用户名
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本

删除凭证

基本信息

Path： /v1/registries/{name}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		凭证名称

返回数据

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

查询凭证

基本信息

Path： /v1/registries/{name}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name		凭证名称

返回数据

名称	类型	是否必须	备注
name	string	非必须	名称
namespace	string	非必须	命名空间
address	string	非必须	镜像地址
username	string	非必须	用户名
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本

查询凭证关联的应用

基本信息

Path： /v1/registries/{name}/apps

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name		凭证名称

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
listOptions	object	非必须	查询选项
├─ selector	string	非必须	标签选择器
├─ fieldSelector	string	非必须	字段选择器
├─ limit	integer	非必须	限制条数
├─ continue	string	非必须
items	object []	非必须	应用列表	item 类型: object
├─ name	string	非必须	应用名称
├─ labels	object	非必须	应用标签对键值对
├─ description	string	非必须	应用描述
├─ namespace	string	非必须	应用命名空间
├─ createTime	string	非必须	创建时间
├─ version	string	非必须	版本
├─ type	string	非必须	应用类型
├─ selector	string	非必须	应用匹配节点标签

罗列凭证

基本信息

Path： /v1/registries

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	备注
fieldSelector	否	字段选择器
selector	否	标签选择器
limit	否	限制条数
continue	否
pageNo	否	页码
pageSize	否	每页数据数
name	否	模糊匹配名称

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	总数量
selector	string	非必须	标签选择器
fieldSelector	string	非必须	字段选择器
limit	string	非必须	限制条数
continue	string	非必须
pageNo	number	非必须
pageSize	number	非必须
items	object []	非必须	列表	item 类型: object
├─ name	string	非必须	名称
├─ namespace	string	非必须	命名空间
├─ address	string	非必须	镜像地址
├─ username	string	非必须	用户名
├─ createTime	string	非必须	创建时间
├─ updateTime	string	非必须	更新时间
├─ description	string	非必须	描述
├─ version	string	非必须	版本

重制密码

基本信息

Path： /v1/registries/{name}/refresh

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name		凭证名称

Body

名称	类型	是否必须	默认值	备注	其他信息
password	string	非必须		密码

返回数据

名称	类型	是否必须	备注
name	string	非必须	名称
namespace	string	非必须	命名空间
address	string	非必须	镜像仓库地址
username	string	非必须	用户名
createTime	string	非必须	创建时间
updateTime	string	非必须	更新时间
description	string	非必须	描述
version	string	非必须	版本

YAPI 接口文档

节点管理

查询节点关联的应用

基本信息

请求参数

返回数据

修改 core 配置（core 自升级）

基本信息

请求参数

返回数据

创建节点

基本信息

请求参数

返回数据

删除节点

基本信息

请求参数

返回数据

批量查询节点

基本信息

请求参数

返回数据

更新节点属性

基本信息

请求参数

返回数据

查询节点

基本信息

请求参数

返回数据

修改节点

基本信息

请求参数

返回数据

查询节点状态信息

基本信息

请求参数

返回数据

罗列当前节点 core 版本号

基本信息

请求参数

返回数据

罗列节点

基本信息

请求参数

返回数据

获取 core 配置

基本信息

请求参数

返回数据

获取安装命令

基本信息

请求参数

返回数据

获取节点属性

基本信息

请求参数

返回数据

证书管理

修改证书

基本信息

请求参数

返回数据

创建证书

基本信息

请求参数

返回数据

删除证书

基本信息

请求参数

返回数据

查询证书

基本信息

请求参数

返回数据

查询证书关联的应用

基本信息

请求参数

返回数据

罗列证书