Path: /v1/nodes/{name}
Method: GET
接口描述:
返回的report和desire不需要做检查
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
name |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | 节点名称 | ||
namespace | string | 非必须 | 命名空间 | ||
description | string | 非必须 | 描述信息 | ||
ready | boolean | 非必须 | 设备是否已连接 | ||
createTime | string | 非必须 | 创建时间 | ||
labels | object | 非必须 | 标签 | ||
annotations | object | 非必须 | 注解,map[string]string 用来保存品牌等属性信息 |
Path: /v1/nodes
Method: GET
接口描述:
1. 返回的report和desire不需要做检查
2. 只检查ready状态
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
selector | 否 | selector="env=test,project=java" 表示匹配env为test并且project为java的节点; selector="env in(dev,test),project=java" 表示匹配project为java且env为dev或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 | 必须 | 标签 | ||
├─ annotations | object | 非必须 | 注解,map[string]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 | 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版本号 |
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类型,用来保存品牌等属性信息,例如:{"brand":"baidu"} | |
description | string | 非必须 | 描述信息 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | 节点名称 | ||
namespace | string | 非必须 | 命名空间 | ||
description | string | 非必须 | 描述信息 | ||
ready | boolean | 非必须 | 节点是否已连接 | ||
createTime | string | 非必须 | 创建时间 | ||
labels | object | 非必须 | 标签 | ||
annotations | object | 非必须 | 注解 |
Path: /v1/nodes/{name}
Method: PUT
接口描述:
返回的report和desire不需要做检查
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
name | 节点名称 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
labels | object | 非必须 | 标签 | ||
annotatins | object | 非必须 | 注解,map[string]string | ||
description | string | 非必须 | 描述信息 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | 节点名称 | ||
namespace | string | 非必须 | 命名空间 | ||
description | string | 非必须 | 描述信息 | ||
ready | boolean | 非必须 | 节点是否已连接 | ||
createTime | string | 非必须 | 创建时间 | ||
labels | object | 非必须 | 标签 | ||
annotations | object | 非必须 | 注解 |
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 | 必须 | 安装命令 |
Path: /v1/register/:batchName/download
Method: GET
接口描述:
用于下载一个产品批次下所有的注册记录
正常时返回二进制数据,错误返回如下结构错误信息:
{
"code": "ResourceNotFound",
"message": "The (batch) resource (0513021) is not found.",
"request-id": "a14fd53d-f3ea-4edb-bef2-b183b9ed0b87"
}
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batchName | r0 | 产品批次名称 |
{"type":"object","title":"title","properties":{}}
Path: /v1/register
Method: POST
接口描述:
创建一个产品/批次,可以用于批量的设备注册管理,提供多种激活方式
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | 名称 | ||
securityType | string | 非必须 | 校验方式,None/Token,默认Token | ||
fingerprint | object | 非必须 | 激活方式信息 | ||
├─ type | integer | 非必须 | 激活方式,sn=1,input=2,hostname=4,bootid=8,systemuuid=16,machineid=32 | ||
├─ snPath | string | 非必须 | 选用sn时,激活文件的路径及名称,默认 /var/lib/baetyl/sn/fingerprint.txt 注意需要使用绝对路径 | ||
├─ inputField | string | 非必须 | 选用input时,获取的字段名称,默认为sn | ||
description | string | 非必须 | 描述信息 | ||
enableWhitelist | integer | 非必须 | 是否开启预注册,默认开启:1 | ||
quotaNum | integer | 非必须 | 数量,默认200 | ||
securityKey | string | 非必须 | 对应于验证方式的key,如用户自定义的token,为空则由系统生成 | ||
callbackName | string | 非必须 | 回调名称 | ||
labels | object | 非必须 | 标签对,激活后设置到对应node上 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 必须 | |||
quotaNum | integer | 必须 | |||
enableWhitelist | integer | 必须 | |||
securityType | string | 必须 | |||
securityKey | string | 非必须 | |||
callbackName | string | 非必须 | |||
labels | object | 必须 | |||
fingerprint | object | 必须 | |||
├─ type | integer | 必须 | |||
├─ snPath | string | 非必须 | |||
├─ inputField | string | 非必须 | |||
description | string | 非必须 | |||
createTime | string | 必须 | |||
updateTime | string | 必须 |
Path: /v1/register
Method: GET
接口描述:
获取已经创建的产品的列表,支持分页查询和按名称过滤查询
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
pageNo | 是 | ||
pageSize | 是 | ||
name | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
total | number | 非必须 | |||
pageNo | number | 必须 | |||
pageSize | number | 必须 | |||
items | object [] | 非必须 |
item 类型: object |
||
├─ name | string | 非必须 | |||
├─ createTime | string | 非必须 | |||
├─ updateTime | string | 非必须 | |||
├─ quotaNum | number | 非必须 | |||
├─ securityType | string | 非必须 | |||
├─ callbackName | string | 非必须 | |||
├─ description | string | 非必须 |
Path: /v1/register/:batch
Method: GET
接口描述:
获取一个产品的详细信息
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batch | product001 | 批次名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 必须 | |||
quotaNum | number | 必须 | |||
enableWhitelist | number | 必须 | |||
securityType | string | 必须 | |||
labels | object | 必须 | |||
fingerprint | object | 非必须 | |||
├─ type | number | 必须 | |||
├─ snPath | string | 非必须 | |||
├─ inputField | string | 非必须 | |||
createTime | string | 必须 | |||
updateTime | string | 必须 | |||
securityKey | string | 非必须 | |||
callbackName | string | 非必须 | |||
description | string | 非必须 |
Path: /v1/register/:batch
Method: DELETE
接口描述:
删除一个指定的产品,如果有注册记录(无论是否激活)则不能删除
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batch | product001 | 批次名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|
Path: /v1/register/:batch
Method: PUT
接口描述:
更新一个指定产品的部分信息
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batch |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
quotaNum | number | 非必须 | |||
labels | object | 非必须 | |||
fingerprint | object | 非必须 | |||
├─ snPath | string | 非必须 | |||
├─ type | integer | 非必须 | |||
├─ inputField | string | 非必须 | |||
callbackName | string | 非必须 | |||
description | string | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | |||
quotaNum | number | 非必须 | |||
enableWhitelist | number | 非必须 | |||
securityType | string | 非必须 | |||
labels | object | 非必须 | |||
fingerprint | object | 非必须 | |||
├─ type | number | 非必须 | |||
├─ snPath | string | 非必须 | |||
├─ inputField | string | 非必须 | |||
createTime | string | 非必须 | |||
updateTime | string | 非必须 | |||
securityKey | string | 非必须 | |||
callbackName | string | 非必须 | |||
description | string | 非必须 |
Path: /v1/register/:batch/init
Method: GET
接口描述:
生成在线安装命令,复制在线命令后在端侧控制台执行即可安装
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batch |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
cmd | string | 必须 |
Path: /v1/register/:batchName/record
Method: POST
接口描述:
添加一条注册记录
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batchName |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | |||
fingerprintValue | string | 非必须 | 指纹信息,激活时比对用 | ||
nodeName | string | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 必须 | |||
batchName | string | 必须 | |||
namespace | string | 必须 | |||
fingerprintValue | string | 必须 | |||
active | integer | 必须 | 是否已经激活 | ||
nodeName | string | 必须 | |||
activeIp | string | 必须 | |||
createTime | string | 必须 | |||
updateTime | string | 必须 |
Path: /v1/register/:batchName/generate
Method: POST
接口描述:
自动生成并插入num条注册记录
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batchName |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
num | number | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
items | string [] | 非必须 |
item 类型: string |
||
├─ | 非必须 | ||||
total | number | 非必须 |
Path: /v1/register/:batchName/record
Method: GET
接口描述:
获取注册记录的列表,可以分页查询和过滤查询
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batchName |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
pageNo | 是 | ||
pageSize | 是 | ||
name | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
total | number | 非必须 | |||
pageNo | number | 必须 | |||
pageSize | string | 必须 | |||
items | object [] | 非必须 |
item 类型: object |
||
├─ name | string | 非必须 | |||
├─ batchName | string | 非必须 | |||
├─ namespace | string | 非必须 | |||
├─ fingerprintValue | string | 非必须 | |||
├─ active | number | 非必须 | |||
├─ nodeName | string | 非必须 | |||
├─ activeIp | string | 非必须 | |||
├─ createTime | string | 非必须 | |||
├─ updateTime | string | 非必须 |
Path: /v1/register/:batchName/record/:recordName
Method: GET
接口描述:
获取一条指定的注册记录的数据
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batchName | ||
recordName |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 必须 | |||
batchName | string | 必须 | |||
namespace | string | 必须 | |||
fingerprintValue | string | 必须 | |||
active | number | 必须 | |||
nodeName | string | 必须 | |||
activeIp | string | 必须 | |||
createTime | string | 必须 | |||
updateTime | string | 必须 |
Path: /v1/register/:batchName/record/:recordName
Method: PUT
接口描述:
更新一条指定的注册记录的信息
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batchName | ||
recordName |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
nodeName | string | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | |||
batchName | string | 非必须 | |||
namespace | string | 非必须 | |||
fingerprintValue | string | 非必须 | |||
active | number | 非必须 | |||
nodeName | string | 非必须 | |||
activeIp | string | 非必须 | |||
createTime | string | 非必须 | |||
updateTime | string | 非必须 |
Path: /v1/register/:batchName/record/:recordName
Method: DELETE
接口描述:
删除一条指定的注册记录
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
batchName | ||
recordName |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|
Path: /v1/apps/{name}
Method: PUT
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
name |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
selector | string | 非必须 | node选择器 | ||
labels | object | 非必须 | 标签 | ||
description | string | 非必须 | 描述信息 | ||
services | object [] | 非必须 | 服务列表 |
item 类型: object |
|
├─ name | string | 非必须 | 服务名称 | ||
├─ labels | object | 非必须 | 标签,map[string]string | ||
├─ image | string | 非必须 | 镜像,容器应用必须,函数应用的话后端会填充 | ||
├─ hostname | string | 非必须 | 主机名 | ||
├─ 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 | 对外暴露端口绑定的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 | ||
├─ 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 | 非必须 | 标签 | ||
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 | |
├─ 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/{name}
Method: GET
接口描述:
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
name |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 非必须 | 应用名称 | ||
namespace | string | 非必须 | 命名空间 | ||
select | string | 非必须 | node选择器 | ||
description | string | 非必须 | 描述信息 | ||
version | string | 非必须 | 版本 | ||
services | object [] | 非必须 | 服务列表 |
item 类型: object |
|
├─ name | string | 非必须 | 应用名称 | ||
├─ image | string | 必须 | 镜像名称 | ||
├─ replica | number | 非必须 | 副本数量 | 如果配置了宿主机端口,副本数不能大于1 | |
├─ 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 | 非必须 | 宿主机端口 | 服务所在宿主机上可以通过该端口访问服务,范围是0-65535 | |
├─ containerPort | integer | 非必须 | 容器端口 | 服务对外暴露端口,其它baetyl启动的服务可以通过该端口访问服务,范围是0-65535 | |
├─ 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: 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 | 必须 | 标签 | ||
description | string | 必须 | 描述信息 | ||
services | object [] | 必须 | 服务列表 |
item 类型: object |
|
├─ name | string | 非必须 | 服务名称 | ||
├─ labels | object | 非必须 | 标签,map[string]string | ||
├─ 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 | 对外暴露端口绑定的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 | ||
├─ 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 | 非必须 | 副本数量 | 如果配置了宿主机端口,副本数不能大于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 | |
├─ 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
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 | 非必须 | 标签 | ||
type | string | 必须 | 应用类型:函数应用、容器应用,分别为 container 和 function |
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",
"endpoint":"http://xx.xx.com",
"bucket":"baetyl",
"object":"func.zip",
"unpack":"zip",
"ak":"xx",
"sk":"xx",
"md5": "xxxx"
}
注: bos, minio 和 awss3 对应的枚举值分别是 baidubos, minio, awss3
函数类型:
{
"type": "function",
"function":"process",
"version":"1",
"runtime":"python36",
"handler": "index.handler",
"bucket":"baetyl-cloud-xx",
"object":"process.zip",
"source":"baidubos",
"unpack": "zip"
}
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 | 否 | abc=test | 对于函数配置项查询:/v1/configs?selector=baetyl-function |
fieldSelector | 否 | metadata.name=test | 标签选择 |
limit | 否 | 限制条数 | |
continue | 否 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
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/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: 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 | 否 | metadata.name=test | 字段选择器 |
selector | 否 | 标签选择器 | |
limit | 否 | 限制条数 | |
continue | 否 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
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/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 | 否 | metadata.name=test | 字段选择器 |
selector | 否 | 标签选择器 | |
limit | 否 | 限制条数 | |
continue | 否 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
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 | 非必须 | 版本 |
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 | 非必须 | 版本 |