节点管理

节点管理

查询节点

基本信息

Path： /v1/nodes/{name}

Method： GET

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

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注
name	string	非必须	节点名称
namespace	string	非必须	命名空间
description	string	非必须	描述信息
ready	boolean	非必须	设备是否已连接
createTime	string	非必须	创建时间
labels	object	非必须	标签
├─ age	string	非必须
├─ loc	string	非必须
annotations	object	非必须	注解，map[string]string 用来保存品牌等属性信息
├─ brand	string	非必须	brand只是一个示例

罗列节点

基本信息

Path： /v1/nodes

Method： GET

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

请求参数

Query

参数名称	是否必须	示例	备注
selector	否	abc=test	标签查询
fieldSelector	否	metadata.name=test	属性查询
limit	否	10	分页限制
continue	否	qwertyuhgfdsasdfghjkjd	分页继续token，由上一次分页查询返回

返回数据

名称	类型	是否必须	备注	其他信息
total	number	非必须	节点总数
listOptions	object	非必须	列表选项
items	object []	非必须	节点列表	item 类型: object
├─ name	string	必须	节点名称
├─ namespace	string	必须	命名空间
├─ description	string	必须	描述信息
├─ ready	boolean	必须	节点是否已连接
├─ createTime	string	必须	创建时间
├─ labels	object	必须	标签
├─ age	string	非必须
├─ loc	string	非必须
├─ annotations	object	非必须	注解，map[string]string 用来保存品牌等属性信息
├─ brand	string	非必须	品牌示例

查询节点信息

基本信息

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

Method： GET

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

请求参数

路径参数

参数名称	示例	备注
name

返回数据

名称	类型	是否必须	备注	其他信息
ready	boolean	非必须	节点是否连接
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(填充instancename）	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(填充instancename）	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版本号

创建节点

基本信息

Path： /v1/nodes

Method： POST

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

请求参数

Headers

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

Body

名称	类型	是否必须	备注
name	string	非必须	节点名称
labels	object	非必须	标签
├─ age	string	非必须
├─ loc	string	非必须
annotations	object	非必须	注解，map[string]string 用来保存品牌等属性信息
├─ brand	string	非必须	brand示例
description	string	非必须	描述信息

返回数据

名称	类型	是否必须	备注
name	string	非必须	节点名称
namespace	string	非必须	命名空间
description	string	非必须	描述信息
ready	boolean	非必须	节点是否已连接
createTime	string	非必须	创建时间
labels	object	非必须	标签
├─ age	string	非必须
├─ loc	string	非必须
annotations	object	非必须	注解
├─ brand	string	非必须

修改节点

基本信息

Path： /v1/nodes/{name}

Method： PUT

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

请求参数

Headers

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

路径参数

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

Body

名称	类型	是否必须	备注
labels	object	非必须	标签
├─ age	string	非必须
├─ loc	string	非必须
annotatins	object	非必须	注解，map[string]string
├─ brand	string	非必须	brand是示例
description	string	非必须	描述信息

返回数据

名称	类型	是否必须	备注
name	string	非必须	节点名称
namespace	string	非必须	命名空间
description	string	非必须	描述信息
ready	boolean	非必须	节点是否已连接
createTime	string	非必须	创建时间
labels	object	非必须	标签
├─ age	string	非必须
├─ loc	string	非必须
annotations	object	非必须	注解
├─ brand	string	非必须

删除节点

基本信息

Path： /v1/nodes/{name}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name	node-1	节点名称

返回数据

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

查询节点关联的应用

基本信息

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

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

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

获取安装命令

基本信息

Path： /v1/nodes/:name/init

Method： GET

接口描述：

请求参数

路径参数

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

返回数据

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