配置项管理

配置项管理

修改配置项

基本信息

Path： /v1/configs/{name}

Method： PUT

接口描述：

请求参数

Headers

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

路径参数

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

Body

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

返回数据

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

返回数据

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