SpaceAPI

class deepfos.api.space.SpaceAPI(header=None, sync=True)

空间服务接口

app: SpaceAppAPI

空间APP信息接口

add(spAppInfoDto)	创建app接口
all(ids)	查询应用列表所有应用(含回收站信息)接口(也可通过appIds查询)（已废弃）
all_list([recycleBin])	查询所有空间内所有应用接口
query_app_info_list_by_space_id()	根据空间id查询所有未回收应用信息接口
remove(appName, appId[, adminFlag, logFlag])	根据空间id删除应用信息接口
update(spAppInfoDto)	修改app名称及描述接口
update_module_register_info_by_module_id(…)	组件安装更新已注册组件的组件名称接口

business: SpaceBusinessRecordAPI

业务文件记录接口

save(fileBusinessRecordSaveDao)

保存业务文件记录

extra: Extra

空间应用相关接口

app_info(appId)	查询单个应用信息接口
app_list(queryAppRequestDTO)	应用列表查询接口
get_all_element([app, appName, elementType, …])	获取当前环境所有空间所有app元素基本信息
get_app_datasource(space, app[, decrypt])	获取应用DB信息接口

file: SpaceFileAPI

附件信息接口

add(fileInfoVo)	保存附件信息接口
find_by_id(id)	通过id查询附件信息接口

internal: SpaceInternalAPI

空间APP信息初始化接口

jdbc()

根据应用id查询单个应用数据库信息（含连接信息）接口

module: SpaceModuleAPI

空间组件注册接口

all_list()	查询所有组件列表接口
auto_register_module(moduleIds)	新建空间组件逐个自动注册接口
batch_module_element_register(…)	批量注册组件和组件依赖关系接口
cancellation(moduleId)	组件注销接口
detail(moduleId)	根据moduleId查询组件详细信息(含服务名)接口
detail_list(moduleIds)	根据(批量)moduleId查询组件(批量)详细信息(含服务名)接口
quote_relation_add(moduleQuoteAddDto)	保存组件创建时使用的默认组件接口
quote_relation_batch_add(moduleQuoteAddDtoList)	保存组件创建时使用的默认组件批量接口
quote_relation_server_name(protocolVersion, …)	根据组件id和协议号查询默认创建的组件服务名接口
register(spModuleRegisterInfoDtoList)	组件注册接口
register_assign_module(moduleTypeVersionInfoDtos)	注册指定的组件接口(指定组件类型和版本)
get_usable_module()	查询已注册的可用组件列表（组）接口
register_coercion_lack_check_usable(moduleId)	查询组件id查询组件在当前空间的状态是否可用接口
register_coercion_lack_check_usable_batch(…)	批量查询组件可用状态接口(是否已注册)
register_status(moduleId)	查询组件注册信息接口
relation_all(moduleId)	根据已注册组件id查询已注册组件关联关系接口
status(moduleStatusDto)	空间组件启用停用接口
unregister_relation_all(moduleId)	根据未注册组件id查询未注册组件关联关系接口
use_elements([enableRegister])	查询当前空间所有可以使用的元素类型信息

user: SpaceUserAPI

用户管理相关接口

all_enable_user([keyword, status])	查询空间用户信息
batch_query_by_user_ids(userIdList[, status])	根据用户id列表批量查询用户信息
check_user_exist_batch(userIdList[, status])	批量校验用户在当前空间是否存在
get_all_children_user_list_by_group(groupId)	获取用户组内所有用户信息接口
get_all_children_user_list_by_group_batch(…)	批量获取用户组内所有用户信息接口
query(userId[, status])	根据id查询单个用户信息
query_batch(userIdList[, status])	根据用户id列表批量查询用户信息
query_batch_by_name(userNames[, status])	根据用户名批量查询空间用户集合
query_batch_by_user_ids(userIdList[, status])	根据用户id列表批量查询用户信息
search(userSearchDto)	查询当前空间用户信息（可包含关键字,不分页）
update(updateInfo)	根据用户id更新用户状态及用户组

user_group: SpaceUserGroupAPI

用户组管理相关接口

add_group(groupInfo)	新建用户组
all_enable_group([keyword])	查询企业用户组信息
get_user_group_all()	获取所有用户组及用户及用户组关系数据
query(groupInfoId[, status])	根据id查询单个用户组信息
query_batch(groupIdList[, filter, status])	批量根据用户组id列表查询用户组信息