mcsmapi.apis package

Submodules

mcsmapi.apis.daemon module

class mcsmapi.apis.daemon.Daemon

基类：object

add(config: dict[str, Any]) → str

新增一个节点。

参数: - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。

返回: - str: 新增节点的ID

delete(daemonId: str) → bool

删除一个节点。

参数: - daemonId (str): 节点的唯一标识符。

返回: - bool: 删除成功后返回True

link(daemonId: str) → bool

连接一个节点。

参数: - daemonId (str): 节点的唯一标识符。

返回: - bool: 连接成功后返回True

update(daemonId: str, config: dict[str, Any]) → bool

更新一个节点的配置。

不建议直接使用此函数，建议调用overview()后在remote属性内使用updateConfig方法按需更新

参数: - daemonId (str): 节点的唯一标识符。 - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。

返回: - bool: 更新成功后返回True

mcsmapi.apis.file module

class mcsmapi.apis.file.File

基类：object

content(daemonId: str, uuid: str, target: str) → str | bytes

获取文件内容

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 文件实例的唯一标识符。 - target (str): 文件的目标路径。

返回: - str: 文件的内容信息。

copy(daemonId: str, uuid: str, copy_map: dict[str, str]) → bool

复制多个文件夹或文件到指定位置。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 文件实例的唯一标识符。 - copy_map (dict): 复制映射，格式为 {源路径: 目标路径}

返回: - bool: 上传成功后返回True。

copyOne(daemonId: str, uuid: str, source: str, target: str) → bool

复制单个文件或文件夹到指定位置。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - source (str): 源文件或文件夹的路径。 - target (str): 目标文件或文件夹的路径。

返回: - bool: 移动成功后返回True。

createFile(daemonId: str, uuid: str, target: str) → bool

创建文件。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - target (str): 目标文件的路径，包含文件名。

返回: - bool: 创建成功后返回True。

createFloder(daemonId: str, uuid: str, target: str) → bool

创建文件夹

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - target (str): 目标文件夹的路径。

返回: - bool: 创建成功后返回True。

delete(daemonId: str, uuid: str, targets: list[str]) → bool

删除多个文件或文件夹。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - targets (list): 要删除的文件或文件夹的路径。

返回: - bool: 删除成功后返回True。

download(daemonId: str, uuid: str, file_name: str) → str

下载文件

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 文件实例的唯一标识符。 - file_name (str): 要下载的文件名。路径+名字, 示例: /backup/world.zip

返回: - str: 文件下载URL。

move(daemonId: str, uuid: str, copy_map: dict[str, str]) → bool

移动多个文件或文件夹到指定位置。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - copy_map (dict): 移动映射，格式为 {源路径: 目标路径}

返回: - bool: 移动成功后返回True。

moveOne(daemonId: str, uuid: str, source: str, target: str) → bool

从源路径移动单个文件或文件夹到目标路径。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - source (str): 源文件或文件夹的路径。 - target (str): 目标文件或文件夹的路径。

返回: - bool: 移动成功后返回True。

rename(daemonId: str, uuid: str, source: str, new_name: str) → bool

重命名单个文件或文件夹。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - source (str): 源文件或文件夹的路径。 - new_name (str): 源文件或文件夹的新名字。

返回: - bool: 重命名成功后返回True。

show(daemonId: str, uuid: str, target: str = '', page: int = 0, page_size: int = 100) → FileList

获取文件列表

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 文件实例的唯一标识符。 - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。 - page (int, 可选): 指定分页的页码。默认为0。 - page_size (int, 可选): 指定每页的项目数量。默认为100。

返回: - FileList: 包含文件列表信息和分页详情的FileList模型。

unzip(daemonId: str, uuid: str, source: str, target: str, code: str = 'utf-8') → bool

解压缩指定的zip文件到目标位置。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - source (str): 需要解压的zip文件路径。 - target (str): 解压到的目标路径。 - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。

可选值: utf-8, gbk, big5

返回: - bool: 解压成功后返回True。

update(daemonId: str, uuid: str, target: str, text: str) → bool

更新文件内容

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 文件实例的唯一标识符。 - target (str): 文件的目标路径。 - text (str): 新的文件内容。

返回: - bool: 更新成功后返回True。

async upload(daemonId: str, uuid: str, file: bytes, upload_dir: str) → bool

上传文件

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 文件实例的唯一标识符。 - file (bytes): 要上传的文件内容。 - upload_dir (str): 文件上传到的目标路径。

返回: - bool: 上传成功后返回True。

zip(daemonId: str, uuid: str, source: str, targets: list[str]) → bool

压缩多个文件或文件夹到指定位置。

参数: - daemonId (str): 守护进程的唯一标识符。 - uuid (str): 实例的唯一标识符。 - source (str): 需要压缩到的 zip 文件路径。 - targets (list): 要压缩的目标文件或文件夹的路径。

返回: - bool: 压缩成功后返回True。

mcsmapi.apis.image module

class mcsmapi.apis.image.Image

基类：object

add(daemonId: str, dockerFile: str, name: str, tag: str) → bool

新增一个镜像

参数: - daemonId (str): 守护进程的唯一标识符。 - dockerFile (str): DockerFile Config - name (str): 镜像名称。 - tag (str): 镜像版本。

返回: - bool: 新增镜像成功后返回True。

containers(daemonId: str) → list[DockerContainerItem]

获取容器列表

参数: - daemonId (str): 守护进程的唯一标识符。

返回: - list[DockerContainerItem]: 包含容器列表详情的 DockerContainerItem 模型的列表。

images(daemonId: str) → list[DockerImageItem]

获取镜像列表

参数: - daemonId (str): 守护进程的唯一标识符。

返回: - list[ImageModel]: 包含镜像列表详情的 ImageModel 模型的列表。

network(daemonId: str) → list[DockerNetworkItem]

获取网络接口列表

参数: - daemonId (str): 守护进程的唯一标识符。

返回: - list[DockerNetworkItem]: 包含网络接口列表详情的 DockerNetworkItem 模型的列表。

progress(daemonId: str) → dict[str, int]

获取镜像构建进度

## 由于文档此部分内容不详，未使用模型

参数: - daemonId (str): 守护进程的唯一标识符。

返回: - dict[str, int]: 包含构建进度信息的字典。

mcsmapi.apis.instance module

class mcsmapi.apis.instance.Instance

基类：object

batchOperation(instances: list[dict[str, str]], operation: str) → bool

对多个实例进行批量操作。

参数: - instances (list[dict[str,str]]): 包含多个实例信息的列表，每个实例信息为一个字典，包含 "uuid" 和 "daemonId" 字段。 - operation (str): 要执行的操作，可以是 "start", "stop", "restart", 或 "kill"。

返回: - list[dict[str,str]]:包含每个实例操作结果的列表，每个结果为一个字典，包含 "uuid" 和 "result" 字段。

command(daemonId: str, uuid: str, command: str) → str

向实例发送命令。

参数: - daemonId (str): 守护进程的ID，用于标识特定的守护进程。 - uuid (str): 实例的唯一标识符，用于指定需要发送命令的实例。 - command (str): 要发送的命令。

返回: - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。

create(daemonId: str, config: dict[str, Any]) → InstanceCreateResult

创建一个实例。

参数: - daemonId (str): 守护进程的唯一标识符，用于关联新创建的实例。 - config (dict[str, Any]): 实例的配置信息，以字典形式提供，缺失内容由InstanceConfig模型补全。

返回: - InstanceCreateResult: 一个包含新创建实例信息的结果对象，内容由InstanceCreateResult模型定义。

delete(daemonId: str, uuids: list[str], deleteFile: bool = False) → list[str]

删除实例。

参数: - daemonId (str): 守护进程的标识符。 - uuids (list): 要删除的实例UUID列表。 - deleteFile (bool, optional): 是否删除关联的文件，默认为False。

返回: - list[str]: 删除操作后返回的UUID列表。

detail(daemonId: str, uuid: str) → InstanceDetail

获取指定实例的详细信息

参数: - daemonId (str): 守护进程的唯一标识符 - uuid (str): 实例的唯一标识符

返回: - InstanceDetail: 包含实例详细信息的模型。

get_output(daemonId: str, uuid: str, size: int | str = '') → str

获取实例输出。

参数: - daemonId (str): 守护进程的ID，用于标识特定的守护进程。 - uuid (str): 实例的唯一标识符，用于指定需要获取输出的实例。 - size (int, optional): 获取的日志大小: 1KB ~ 2048KB，如果未设置，则返回所有日志

返回: - str: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。

kill(daemonId: str, uuid: str) → str | bool

强制关闭实例。

参数: - daemonId (str): 守护进程的ID，用于标识特定的守护进程。 - uuid (str): 实例的唯一标识符，用于指定需要强制关闭的实例。

返回: - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。

reinstall(daemonId: str, uuid: str, targetUrl: str, title: str = '', description: str = '') → bool

重装实例。

参数: - daemonId (str): 守护进程的ID，用于标识特定的守护进程。 - uuid (str): 实例的唯一标识符。 - targetUrl (str): 重装文件的目标URL。 - title (str): 重装文件的标题。 - description (str, optional): 重装文件的描述，默认为空字符串。

返回: - bool: 返回操作结果，成功时返回True。

restart(daemonId: str, uuid: str) → str | bool

重启实例。

参数: - daemonId (str): 守护进程的ID，用于标识特定的守护进程。 - uuid (str): 实例的唯一标识符，用于指定需要重启的实例。

返回: - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。

search(daemonId: str, page: int = 1, page_size: int = 20, instance_name: str = '', status: str = '', tag: list[str] | None = None) → InstanceSearchList

根据指定的参数搜索实例信息

参数: - daemonId (str): 守护进程的唯一标识符 - page (int): 页码，用于指示返回数据的页数。默认为1，表示返回第一页数据 - page_size (int): 每页大小，用于指定每页包含的数据条数。默认为20，表示每页包含20条数据 - instance_name (str): 实例的名称。默认为空字符串，表示不进行实例名称过滤 - status (str): 实例的状态。默认为空字符串，表示不进行状态过滤 - tag (list[str] | None): 实例的标签列表。默认为None，表示不进行标签过滤

返回: - InstanceSearchList: 包含搜索结果的模型。该模型包含了符合搜索条件的实例信息列表，以及总数据条数、总页数等分页信息。

start(daemonId: str, uuid: str) → str | bool

启动实例。

参数: - daemonId (str): 守护进程的ID，用于标识特定的守护进程。 - uuid (str): 实例的唯一标识符，用于指定需要启动的实例。

返回: - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。

stop(daemonId: str, uuid: str) → str | bool

关闭实例。

参数: - daemonId (str): 守护进程的ID，用于标识特定的守护进程。 - uuid (str): 实例的唯一标识符，用于指定需要关闭的实例。

返回: - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。

update(daemonId: str, uuid: str) → bool

升级实例。

参数: - daemonId (str): 守护进程的ID，用于标识特定的守护进程。 - uuid (str): 实例的唯一标识符，用于指定需要升级的实例。

返回: - bool: 返回操作结果，成功时返回True。

updateConfig(daemonId: str, uuid: str, config: dict) → str | bool

更新实例配置。

不建议直接使用此函数，建议调用search后在data属性内使用updateConfig方法按需更新

参数: - daemonId (str): 守护进程的标识符。 - uuid (str): 实例的唯一标识符。 - config (dict): 新的实例配置，以字典形式提供，缺失内容由InstanceConfig模型补全。

返回: - str|bool: 更新成功后返回更新的实例UUID，如果未找到该字段，则默认返回True。

mcsmapi.apis.overview module

class mcsmapi.apis.overview.Overview

基类：object

init()

初始化方法，用于获取API概览信息并构建概览模型。

本方法通过发送GET请求获取API概览信息，确保返回的数据类型为字典， 然后使用这些数据来构建一个OverviewModel实例。

返回:

返回一个OverviewModel实例，该实例使用获取的API概览信息进行初始化。

mcsmapi.apis.user module

class mcsmapi.apis.user.User

基类：object

create(username: str, password: str, permission: int = 1) → str | bool

创建新用户的方法

参数: - username (str): 用户名，字符串类型 - password (str): 密码，字符串类型 - permission (int): 权限等级，整数类型，默认值为1

返回: - str|bool: 创建成功后返回用户的UUID，如果未找到该字段，则默认返回True。

delete(uuids: list[str]) → bool

删除用户的方法

参数: - uuids (list[str]): 包含要删除的用户UUID的列表。

返回: - bool: 成功时返回True

search(username: str = '', page: int = 1, page_size: int = 20, role: str = '') → SearchUserModel

根据用户名和角色搜索用户信息

参数: - username (str): 要搜索的用户名。默认为空字符串，表示不进行用户名过滤 - page (int): 页码，用于指示返回数据的页数。默认为1，表示返回第一页数据 - page_size (int): 每页大小，用于指定每页包含的数据条数。默认为20，表示每页包含20条数据 - role (str): 用户权限。默认为空字符串，表示不进行权限过滤

可用的值为 1=用户, 10=管理员, -1=被封禁的用户

返回: - SearchUserModel: 包含搜索结果的模型。该模型包含了符合搜索条件的用户信息列表，以及总数据条数、总页数等分页信息。

update(uuid: str, config: dict[str, Any]) → bool

更新用户信息的方法

不建议直接使用此函数，建议调用search后使用update方法按需更新

参数: - uuid (str): 用户的唯一标识符UUID - config (dict[str, Any]): 新的用户信息，以字典形式提供，缺失内容由UserConfig模型补全。

返回: - bool: 成功时返回True

Module contents