SpaceModuleAPI

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

all_list()

查询所有组件列表接口

返回类型

Union[List[SpModuleInfoPageVo], Awaitable[List[SpModuleInfoPageVo]]]

auto_register_module(moduleIds)

新建空间组件逐个自动注册接口

组件逐个注册

参数

moduleIds – List[str]

返回类型

Union[Any, Awaitable[Any]]

batch_module_element_register(moduleRegisterAndQuoteDto)

批量注册组件和组件依赖关系接口

参数

moduleRegisterAndQuoteDto – ModuleRegisterAndQuoteDto

返回类型

Union[SpModuleRegisterResultVo, Awaitable[SpModuleRegisterResultVo]]

cancellation(moduleId)

组件注销接口

组件注销,删除组件注册表,调用系统服务删除空间与组件关联关系,更新组件 强制关联关系状态,删除组件引用信息

参数

moduleId – str

返回类型

Union[int, Awaitable[int]]

detail(moduleId)

根据moduleId查询组件详细信息(含服务名)接口

该接口迁移至system项目

参数

moduleId – str

返回类型

Union[SpModuleRegisterDetailVo, Awaitable[SpModuleRegisterDetailVo]]

detail_list(moduleIds)

根据(批量)moduleId查询组件(批量)详细信息(含服务名)接口

该接口迁移至system项目

参数

moduleIds – List[str]

返回类型

Union[List[SpModuleRegisterDetailVo], Awaitable[List[SpModuleRegisterDetailVo]]]

get_usable_module()

查询已注册的可用组件列表（组）接口

查询已注册的可用组件列表（组件状态为可用）

返回类型

Union[List[SpModuleRegisterDetailVo], Awaitable[List[SpModuleRegisterDetailVo]]]

quote_relation_add(moduleQuoteAddDto)

保存组件创建时使用的默认组件接口

参数

moduleQuoteAddDto – ModuleQuoteAddDto

返回类型

Union[int, Awaitable[int]]

quote_relation_batch_add(moduleQuoteAddDtoList)

保存组件创建时使用的默认组件批量接口

参数

moduleQuoteAddDtoList – List[ModuleQuoteAddDto]

返回类型

Union[int, Awaitable[int]]

quote_relation_server_name(protocolVersion, protocol, moduleId)

根据组件id和协议号查询默认创建的组件服务名接口

参数

• protocolVersion – str

• protocol – str

• moduleId – str

返回类型

Union[SpModuleAutoCreateRelationVo, Awaitable[SpModuleAutoCreateRelationVo]]

register(spModuleRegisterInfoDtoList)

组件注册接口

组件注册,存在后置通知

参数

spModuleRegisterInfoDtoList – List[SpModuleRegisterInfoDto]

返回类型

Union[SpModuleRegisterResultVo, Awaitable[SpModuleRegisterResultVo]]

register_assign_module(moduleTypeVersionInfoDtos)

注册指定的组件接口(指定组件类型和版本)

参数

moduleTypeVersionInfoDtos – List[ModuleTypeVersionInfoDto]

返回类型

Union[Any, Awaitable[Any]]

register_coercion_lack_check_usable(moduleId)

查询组件id查询组件在当前空间的状态是否可用接口

根据moduleId查询空间注册的组件状态是否可用且强依赖关系是否注册

参数

moduleId – str

返回类型

Union[bool, Awaitable[bool]]

register_coercion_lack_check_usable_batch(moduleIds)

批量查询组件可用状态接口(是否已注册)

根据空间id和组件id数组批量查询组件可用状态(是否已注册)

参数

moduleIds – List[str]

返回类型

Union[List[SpModlueRegisterStausUsableVo], Awaitable[List[SpModlueRegisterStausUsableVo]]]

register_status(moduleId)

查询组件注册信息接口

根据空间id和组件id查询组件注册信息包含状态和注册时间

参数

moduleId – str

返回类型

Union[ModuleRegisterStatusAndRegisterTimeVo, Awaitable[ModuleRegisterStatusAndRegisterTimeVo]]

relation_all(moduleId)

根据已注册组件id查询已注册组件关联关系接口

根据空间id和已注册组件id判断该组件是否已经注册,根据空间id和已注 册组件id获取组件创建的依赖关系,根据空间id获取该空间已注册的组件 ,调用系统服务根据未注册组件id获取组件所有的依赖关系,根据已注册组件 id显示强制依赖和不强制依赖列表未注册的组件不会显示

参数

moduleId – str

返回类型

Union[SpModuleRegisterRelationVo, Awaitable[SpModuleRegisterRelationVo]]

status(moduleStatusDto)

空间组件启用停用接口

更新空间组件启用停用状态

参数

moduleStatusDto – ModuleStatusDto

返回类型

Union[int, Awaitable[int]]

unregister_relation_all(moduleId)

根据未注册组件id查询未注册组件关联关系接口

根据空间id和未注册组件id判断该组件是否已经注册,根据空间id获取所 有已注册的组件信息用于显示与未注册组件的关联关系列表,调用系统服务根据 未注册组件id获取组件所有的依赖关系,根据未注册组件id显示强制依赖和 不强制依赖列表已经注册的组件不会显示

参数

moduleId – str

返回类型

Union[SpModuleRegisterRelationVo, Awaitable[SpModuleRegisterRelationVo]]

use_elements(enableRegister=None)

查询当前空间所有可以使用的元素类型信息

参数

enableRegister – Optional[int]

返回类型

Union[List[ModuleElementInfoForm], Awaitable[List[ModuleElementInfoForm]]]