SpaceAppAPI

class deepfos.api.space.SpaceAppAPI(root: deepfos.api.base.RootAPI)

add(spAppInfoDto)

创建app接口

在当前空间创建app，如果数据库连接地址、端口、数据库名、数据库用户名 、密码为空时，使用默认数据源

参数

spAppInfoDto – SpAppInfoAddDto

返回类型

Union[str, Awaitable[str]]

all(ids)

查询应用列表所有应用(含回收站信息)接口(也可通过appIds查询)（已废弃）

根据空间id和应用名称分页查询应用列表所有应用（已废弃）

参数

ids – List[str]

返回类型

Union[List[SpAppInfoVo], Awaitable[List[SpAppInfoVo]]]

all_list(recycleBin=None)

查询所有空间内所有应用接口

查询所有空间及空间下所有应用；可根据参数recycleBin过滤应用

参数

recycleBin – Optional[int]

返回类型

Union[List[SpaceAppDto], Awaitable[List[SpaceAppDto]]]

query_app_info_list_by_space_id()

根据空间id查询所有未回收应用信息接口

返回类型

Union[List[AppInfo], Awaitable[List[AppInfo]]]

remove(appName, appId, adminFlag=None, logFlag=None)

根据空间id删除应用信息接口

根据空间id和应用id调用app应用接口通知应用删除所有应用下元素数据 ,根据空间id和应用id删除应用信息–2.12.0.0

参数

• appName – str

• appId – str

• adminFlag – Optional[bool]

• logFlag – Optional[bool]

返回类型

Union[int, Awaitable[int]]

update(spAppInfoDto)

修改app名称及描述接口

应用名称和描述修改

参数

spAppInfoDto – SpAppInfoUpdateDto

返回类型

Union[int, Awaitable[int]]

update_module_register_info_by_module_id(spModuleRegisterInfoUpdateDto)

组件安装更新已注册组件的组件名称接口

根据组件id修改空间组件注册表中组件名称

参数

spModuleRegisterInfoUpdateDto – SpModuleRegisterInfoUpdateDto

返回类型

Union[int, Awaitable[int]]