SysModuleAPI

class deepfos.api.system.SysModuleAPI(root: deepfos.api.base.RootAPI)

get_server_name(moduleIdList)

根据组件id查询服务名与版本号接口

根据组件id查询组件对应服务名与版本号

参数

moduleIdList – List[str]

返回类型

Union[List[ModuleServerVO], Awaitable[List[ModuleServerVO]]]

install_module(installModuleDTO)

组件登记基本信息接口

组件服务启用时安装组件相关信息，包含组件名称多语言、支持协议信息、使用 协议信息、自动创建协议信息、组件操作前置和后置通知信息、元素支持和默认 语言信息、元素升级信息等，注意禁止出现组件依赖本身的情况出现

参数

installModuleDTO – InstallModuleDTO

返回类型

Union[int, Awaitable[int]]

judge_module_exist(moduleIdList)

查询组件id是否存在接口

根据组件id查询对应组件是否存在

参数

moduleIdList – List[str]

返回类型

Union[List[ModuleExistVO], Awaitable[List[ModuleExistVO]]]

module_elementary_info(moduleIds)

根据moduleId查询基本信息接口

参数

moduleIds – List[str]

返回类型

Union[List[ModuleElementaryInfoVO], Awaitable[List[ModuleElementaryInfoVO]]]

module_info_list(moduleIds)

批量查询组件信息接口

批量查询-根据组件id查询组件信息

参数

moduleIds – List[str]

返回类型

Union[List[ModuleInfoDTO], Awaitable[List[ModuleInfoDTO]]]

query_module_name(elModuleName=None, moduleInfoList=None)

根据不同条件查询组件信息接口

功能一：根据elModuleName模糊查询组件信息;功能二：根据 moduleType和moduleVersion精确查询组件信息

参数

• elModuleName – Optional[str]

• moduleInfoList – Optional[List[ModuleInfo]]

返回类型

Union[List[ModuleInfo], Awaitable[List[ModuleInfo]]]

space_register_module(spaceId)

获取所有组件列表以及协议关联的其他组件接口

获取所有组件列表以及组件支持协议、使用协议、自动创建协议关联的其他组件 ,包含组件所关联的下一层级的组件信息

参数

spaceId – str

返回类型

Union[List[RegisterModuleVO], Awaitable[List[RegisterModuleVO]]]