mcsmapi 0.1.4__py3-none-any.whl → 0.1.5b2__py3-none-any.whl

mcsmapi/apis/instance.py

@@ -23,15 +23,15 @@ class Instance:
         根据指定的参数搜索实例信息
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符
-       <br> - page (int): 页码，用于指示返回数据的页数。默认为1，表示返回第一页数据
-       <br> - page_size (int): 每页大小，用于指定每页包含的数据条数。默认为20，表示每页包含20条数据
-       <br> - instance_name (str): 实例的名称。默认为空字符串，表示不进行实例名称过滤
-       <br> - status (str): 实例的状态。默认为空字符串，表示不进行状态过滤
-       <br> - tag (list[str] | None): 实例的标签列表。默认为None，表示不进行标签过滤
+        - daemonId (str): 守护进程的唯一标识符
+        - page (int): 页码，用于指示返回数据的页数。默认为1，表示返回第一页数据
+        - page_size (int): 每页大小，用于指定每页包含的数据条数。默认为20，表示每页包含20条数据
+        - instance_name (str): 实例的名称。默认为空字符串，表示不进行实例名称过滤
+        - status (str): 实例的状态。默认为空字符串，表示不进行状态过滤
+        - tag (list[str] | None): 实例的标签列表。默认为None，表示不进行标签过滤
 
         **返回:**
-       <br> - InstanceSearchList: 包含搜索结果的模型。该模型包含了符合搜索条件的实例信息列表，以及总数据条数、总页数等分页信息。
+        - InstanceSearchList: 包含搜索结果的模型。该模型包含了符合搜索条件的实例信息列表，以及总数据条数、总页数等分页信息。
         """
         if tag is None:
             tag = []
@@ -54,11 +54,11 @@ class Instance:
         获取指定实例的详细信息
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符
-       <br> - uuid (str): 实例的唯一标识符
+        - daemonId (str): 守护进程的唯一标识符
+        - uuid (str): 实例的唯一标识符
 
         **返回:**
-       <br> - InstanceDetail: 包含实例详细信息的模型。
+        - InstanceDetail: 包含实例详细信息的模型。
         """
         result = send(
             "GET",
@@ -72,11 +72,11 @@ class Instance:
         创建一个实例。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的唯一标识符，用于关联新创建的实例。
-       <br> - config (dict[str, Any]): 实例的配置信息，以字典形式提供，缺失内容由InstanceConfig模型补全。
+        - daemonId (str): 守护进程的唯一标识符，用于关联新创建的实例。
+        - config (dict[str, Any]): 实例的配置信息，以字典形式提供，缺失内容由InstanceConfig模型补全。
 
         **返回:**
-       <br> - InstanceCreateResult: 一个包含新创建实例信息的结果对象，内容由InstanceCreateResult模型定义。
+        - InstanceCreateResult: 一个包含新创建实例信息的结果对象，内容由InstanceCreateResult模型定义。
         """
         result = send(
             "POST",
@@ -93,12 +93,12 @@ class Instance:
         **不建议直接使用此函数，建议调用search后在data属性内使用updateConfig方法按需更新**
 
         **参数:**
-       <br> - daemonId (str): 守护进程的标识符。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - config (dict): 新的实例配置，以字典形式提供，缺失内容由InstanceConfig模型补全。
+        - daemonId (str): 守护进程的标识符。
+        - uuid (str): 实例的唯一标识符。
+        - config (dict): 新的实例配置，以字典形式提供，缺失内容由InstanceConfig模型补全。
 
         **返回:**
-       <br> - str|bool: 更新成功后返回更新的实例UUID，如果未找到该字段，则默认返回True。
+        - str|bool: 更新成功后返回更新的实例UUID，如果未找到该字段，则默认返回True。
         """
         result = send(
             "PUT",
@@ -115,12 +115,12 @@ class Instance:
         删除实例。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的标识符。
-       <br> - uuids (list): 要删除的实例UUID列表。
-       <br> - deleteFile (bool, optional): 是否删除关联的文件，默认为False。
+        - daemonId (str): 守护进程的标识符。
+        - uuids (list): 要删除的实例UUID列表。
+        - deleteFile (bool, optional): 是否删除关联的文件，默认为False。
 
         **返回:**
-       <br> - list[str]: 删除操作后返回的UUID列表。
+        - list[str]: 删除操作后返回的UUID列表。
         """
         return send(
             "DELETE",
@@ -134,11 +134,11 @@ class Instance:
         启动实例。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
-       <br> - uuid (str): 实例的唯一标识符，用于指定需要启动的实例。
+        - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
+        - uuid (str): 实例的唯一标识符，用于指定需要启动的实例。
 
         **返回:**
-       <br> - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
         result = send(
             "GET",
@@ -152,11 +152,11 @@ class Instance:
         关闭实例。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
-       <br> - uuid (str): 实例的唯一标识符，用于指定需要关闭的实例。
+        - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
+        - uuid (str): 实例的唯一标识符，用于指定需要关闭的实例。
 
         **返回:**
-       <br> - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
         result = send(
             "GET",
@@ -170,11 +170,11 @@ class Instance:
         重启实例。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
-       <br> - uuid (str): 实例的唯一标识符，用于指定需要重启的实例。
+        - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
+        - uuid (str): 实例的唯一标识符，用于指定需要重启的实例。
 
         **返回:**
-       <br> - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
         result = send(
             "GET",
@@ -188,11 +188,11 @@ class Instance:
         强制关闭实例。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
-       <br> - uuid (str): 实例的唯一标识符，用于指定需要强制关闭的实例。
+        - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
+        - uuid (str): 实例的唯一标识符，用于指定需要强制关闭的实例。
 
         **返回:**
-       <br> - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
         result = send(
             "GET",
@@ -206,11 +206,11 @@ class Instance:
         对多个实例进行批量操作。
 
         **参数:**
-       <br> - instances (list[dict[str,str]]): 包含多个实例信息的列表，每个实例信息为一个字典，包含 "uuid" 和 "daemonId" 字段。
-       <br> - operation (str): 要执行的操作，可以是 "start", "stop", "restart", 或 "kill"。
+        - instances (list[dict[str,str]]): 包含多个实例信息的列表，每个实例信息为一个字典，包含 "uuid" 和 "daemonId" 字段。
+        - operation (str): 要执行的操作，可以是 "start", "stop", "restart", 或 "kill"。
 
         **返回:**
-       <br> - list[dict[str,str]]:包含每个实例操作结果的列表，每个结果为一个字典，包含 "uuid" 和 "result" 字段。
+        - list[dict[str,str]]:包含每个实例操作结果的列表，每个结果为一个字典，包含 "uuid" 和 "result" 字段。
         """
         if operation in {"start", "stop", "restart", "kill"}:
             return send("POST", f"{ApiPool.INSTANCE}/multi_{operation}", data=instances)
@@ -222,11 +222,11 @@ class Instance:
         升级实例。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
-       <br> - uuid (str): 实例的唯一标识符，用于指定需要升级的实例。
+        - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
+        - uuid (str): 实例的唯一标识符，用于指定需要升级的实例。
 
         **返回:**
-       <br> - bool: 返回操作结果，成功时返回True。
+        - bool: 返回操作结果，成功时返回True。
         """
         return send(
             "GET",
@@ -239,12 +239,12 @@ class Instance:
         向实例发送命令。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
-       <br> - uuid (str): 实例的唯一标识符，用于指定需要发送命令的实例。
-       <br> - command (str): 要发送的命令。
+        - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
+        - uuid (str): 实例的唯一标识符，用于指定需要发送命令的实例。
+        - command (str): 要发送的命令。
 
         **返回:**
-       <br> - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        - str|bool: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
         result = send(
             "GET",
@@ -258,12 +258,12 @@ class Instance:
         获取实例输出。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
-       <br> - uuid (str): 实例的唯一标识符，用于指定需要获取输出的实例。
-       <br> - size (int, optional): 获取的日志大小: 1KB ~ 2048KB，如果未设置，则返回所有日志
+        - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
+        - uuid (str): 实例的唯一标识符，用于指定需要获取输出的实例。
+        - size (int, optional): 获取的日志大小: 1KB ~ 2048KB，如果未设置，则返回所有日志
 
         **返回:**
-       <br> - str: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
+        - str: 返回结果中的 "instanceUuid" 字段值，如果未找到该字段，则默认返回True。
         """
         return send(
             "GET",
@@ -283,14 +283,14 @@ class Instance:
         重装实例。
 
         **参数:**
-       <br> - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
-       <br> - uuid (str): 实例的唯一标识符。
-       <br> - targetUrl (str): 重装文件的目标URL。
-       <br> - title (str): 重装文件的标题。
-       <br> - description (str, optional): 重装文件的描述，默认为空字符串。
+        - daemonId (str): 守护进程的ID，用于标识特定的守护进程。
+        - uuid (str): 实例的唯一标识符。
+        - targetUrl (str): 重装文件的目标URL。
+        - title (str): 重装文件的标题。
+        - description (str, optional): 重装文件的描述，默认为空字符串。
 
         **返回:**
-       <br> - bool: 返回操作结果，成功时返回True。
+        - bool: 返回操作结果，成功时返回True。
         """
         return send(
             "POST",

mcsmapi/apis/user.py

@@ -11,14 +11,14 @@ class User:
         """根据用户名和角色搜索用户信息
 
         **参数:**
-       <br> - username (str): 要搜索的用户名。默认为空字符串，表示不进行用户名过滤
-       <br> - page (int): 页码，用于指示返回数据的页数。默认为1，表示返回第一页数据
-       <br> - page_size (int): 每页大小，用于指定每页包含的数据条数。默认为20，表示每页包含20条数据
-       <br> - role (str): 用户权限。默认为空字符串，表示不进行权限过滤
+        - username (str): 要搜索的用户名。默认为空字符串，表示不进行用户名过滤
+        - page (int): 页码，用于指示返回数据的页数。默认为1，表示返回第一页数据
+        - page_size (int): 每页大小，用于指定每页包含的数据条数。默认为20，表示每页包含20条数据
+        - role (str): 用户权限。默认为空字符串，表示不进行权限过滤
                      可用的值为 1=用户, 10=管理员, -1=被封禁的用户
 
         **返回:**
-       <br> - SearchUserModel: 包含搜索结果的模型。该模型包含了符合搜索条件的用户信息列表，以及总数据条数、总页数等分页信息。
+        - SearchUserModel: 包含搜索结果的模型。该模型包含了符合搜索条件的用户信息列表，以及总数据条数、总页数等分页信息。
         """
         result = send(
             "GET",
@@ -37,12 +37,12 @@ class User:
         创建新用户的方法
 
         **参数:**
-       <br> - username (str): 用户名，字符串类型
-       <br> - password (str): 密码，字符串类型
-       <br> - permission (int): 权限等级，整数类型，默认值为1
+        - username (str): 用户名，字符串类型
+        - password (str): 密码，字符串类型
+        - permission (int): 权限等级，整数类型，默认值为1
 
         **返回:**
-       <br> - str|bool: 创建成功后返回用户的UUID，如果未找到该字段，则默认返回True。
+        - str|bool: 创建成功后返回用户的UUID，如果未找到该字段，则默认返回True。
         """
         return send(
             "POST",
@@ -57,11 +57,11 @@ class User:
         **不建议直接使用此函数，建议调用search后使用update方法按需更新**
 
         **参数:**
-       <br> - uuid (str): 用户的唯一标识符UUID
-       <br> - config (dict[str, Any]): 新的用户信息，以字典形式提供，缺失内容由UserConfig模型补全。
+        - uuid (str): 用户的唯一标识符UUID
+        - config (dict[str, Any]): 新的用户信息，以字典形式提供，缺失内容由UserConfig模型补全。
 
         **返回:**
-       <br> - bool: 成功时返回True
+        - bool: 成功时返回True
         """
         return send(
             "PUT",
@@ -74,9 +74,9 @@ class User:
         删除用户的方法
 
         **参数:**
-       <br> - uuids (list[str]): 包含要删除的用户UUID的列表。
+        - uuids (list[str]): 包含要删除的用户UUID的列表。
 
         **返回:**
-       <br> - bool: 成功时返回True
+        - bool: 成功时返回True
         """
         return send("DELETE", ApiPool.AUTH, data=uuids)

mcsmapi/models/daemon.py

@@ -4,48 +4,89 @@ from mcsmapi.models.instance import InstanceCreateResult
 
 
 class CpuMemChart(BaseModel):
+    """节点资源使用率信息"""
+
+    """cpu使用率"""
     cpu: float = 0
+    """内存使用率"""
     mem: float = 0
 
 
 class ProcessInfo(BaseModel):
+    """节点进程详细信息"""
+
+    """远程节点使用的cpu资源(单位: byte)"""
     cpu: int = 0
+    """远程节点使用的内存资源(单位: byte)"""
     memory: int = 0
+    """远程节点的工作路径"""
     cwd: str = ""
 
 
 class InstanceInfo(BaseModel):
+    """实例统计信息"""
+
+    """运行中实例数量"""
     running: int = 0
+    """全部实例数量"""
     total: int = 0
 
 
 class SystemInfo(BaseModel):
+    """节点系统信息"""
+
+    """系统类型"""
     type: str = ""
+    """主机名"""
     hostname: str = ""
+    """平台架构"""
     platform: str = ""
+    """系统版本"""
     release: str = ""
+    """系统运行时间(单位: sec)"""
     uptime: float = 0
+    """远程节点运行路径"""
     cwd: str = ""
+    """系统负载平均值（仅适用于 Linux 和 macOS），表示过去 **1 分钟、5 分钟、15 分钟** 内的 CPU 负载情况"""
     loadavg: List[float] = []
+    """可用内存(单位: byte)"""
     freemem: int = 0
+    """cpu使用率"""
     cpuUsage: float = 0
+    """内存使用率"""
     memUsage: float = 0
+    """内存总量(单位: byte)"""
     totalmem: int = 0
+    """未知，在MCSM代码中始终为0"""
     processCpu: int = 0
+    """未知，在MCSM代码中始终为0"""
     processMem: int = 0
 
 
 class DaemonModel(BaseModel):
+    """节点详细信息"""
+
+    """远程节点版本"""
     version: str = ""
+    """远程节点的基本信息"""
     process: ProcessInfo = ProcessInfo()
+    """远程节点实例基本信息"""
     instance: InstanceInfo = InstanceInfo()
+    """远程节点系统信息"""
     system: SystemInfo = SystemInfo()
+    """cpu和内存使用趋势"""
     cpuMemChart: List[CpuMemChart] = []
+    """远程节点的uuid"""
     uuid: str = ""
+    """远程节点的ip"""
     ip: str = ""
+    """远程节点的端口"""
     port: int = 24444
+    """远程节点的路径前缀"""
     prefix: str = ""
+    """远程节点的可用状态"""
     available: bool = False
+    """远程节点的备注"""
     remarks: str = ""
 
     def delete(self) -> bool:
@@ -53,7 +94,7 @@ class DaemonModel(BaseModel):
         删除该节点。
 
         返回:
-       <br> - bool: 删除成功后返回True
+        - bool: 删除成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
@@ -64,7 +105,7 @@ class DaemonModel(BaseModel):
         链接该节点。
 
         返回:
-       <br> - bool: 链接成功后返回True
+        - bool: 链接成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
@@ -75,10 +116,10 @@ class DaemonModel(BaseModel):
         更新该节点的配置。
 
         参数:
-       <br> - config (dict[str, Any]): 节点的配置信息，以字典形式提供，缺失内容使用原节点配置填充。
+        - config (dict[str, Any]): 节点的配置信息，以字典形式提供，缺失内容使用原节点配置填充。
 
         返回:
-       <br> - bool: 更新成功后返回True
+        - bool: 更新成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
@@ -100,10 +141,10 @@ class DaemonModel(BaseModel):
         在当前节点创建一个实例。
 
         参数:
-       <br> - config (dict[str, Any]): 实例的配置信息，以字典形式提供，缺失内容由InstanceConfig模型补全。
+        - config (dict[str, Any]): 实例的配置信息，以字典形式提供，缺失内容由InstanceConfig模型补全。
 
         返回:
-       <br> - InstanceCreateResult: 一个包含新创建实例信息的结果对象，内容由InstanceCreateResult模型定义。
+        - InstanceCreateResult: 一个包含新创建实例信息的结果对象，内容由InstanceCreateResult模型定义。
         """
         from mcsmapi.apis.instance import Instance
         from .instance import InstanceConfig
@@ -115,11 +156,11 @@ class DaemonModel(BaseModel):
         删除当前节点的一个或多个实例。
 
         参数:
-       <br> - uuids (list[str]): 要删除的实例UUID列表。
-       <br> - deleteFile (bool, optional): 是否删除关联的文件，默认为False。
+        - uuids (list[str]): 要删除的实例UUID列表。
+        - deleteFile (bool, optional): 是否删除关联的文件，默认为False。
 
         返回:
-       <br> - list[str]: 删除操作后返回的UUID列表。
+        - list[str]: 删除操作后返回的UUID列表。
         """
         from mcsmapi.apis.instance import Instance
 
@@ -127,8 +168,15 @@ class DaemonModel(BaseModel):
 
 
 class DaemonConfig(BaseModel):
+    """节点配置信息"""
+
+    """远程节点的ip"""
     ip: str = "localhost"
+    """远程节点的端口"""
     port: int = 24444
+    """远程节点的路径前缀"""
     prefix: str = ""
+    """远程节点的备注"""
     remarks: str = "New Daemon"
+    """远程节点的可用状态"""
     available: bool = True

mcsmapi/models/file.py

@@ -4,24 +4,36 @@ import os
 
 
 class FileItem(BaseModel):
-    name: str = "New File"
+    """文件信息"""
+
+    """文件名称"""
+    name: str = ""
+    """文件大小(单位: byte)"""
     size: int = 0  # byte
+    """文件修改时间"""
     time: str = ""
+    """文件操作权限(仅适用于Linux)"""
     mode: int = 777  # Linux file permission
+    """文件类型，`0`为文件夹，`1`为文件"""
     type: int = 0  # 0 = Folder, 1 = File
+    """远程节点uuid"""
     daemonId: str = ""
+    """实例的uiid"""
     uuid: str = ""
+    """文件所在路径"""
     target: str = ""
+    """当前文件列表过滤条件"""
+    file_name: str = ""
 
     def rename(self, newName: str) -> bool:
         """
         重命名该文件或文件夹。
 
         **参数:**
-       <br> - new_name (str): 源文件或文件夹的新名字。
+        - new_name (str): 源文件或文件夹的新名字。
 
         **返回:**
-       <br> - bool: 重命名成功后返回True。
+        - bool: 重命名成功后返回True。
         """
         from mcsmapi.apis.file import File
 
@@ -34,7 +46,7 @@ class FileItem(BaseModel):
         删除该文件或文件夹。
 
         **返回:**
-       <br> - bool: 重命名成功后返回True。
+        - bool: 重命名成功后返回True。
         """
         from mcsmapi.apis.file import File
 
@@ -54,10 +66,10 @@ class FileItem(BaseModel):
         移动该文件或文件夹到目标路径。
 
         **参数:**
-       <br> - target (str): 目标文件或文件夹的路径。
+        - target (str): 目标文件或文件夹的路径。
 
         **返回:**
-       <br> - bool: 移动成功后返回True。
+        - bool: 移动成功后返回True。
         """
         from mcsmapi.apis.file import File
 
@@ -65,17 +77,45 @@ class FileItem(BaseModel):
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target
         )
 
+    def content(self):
+        """
+        获取文件内容。
+        **返回:**
+        - str | bytes: 文件内容。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().content(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name)
+        )
+
+    def zip(self, targets: list[str]) -> bool:
+        """
+        压缩多个文件或文件夹到指定位置。
+
+        **参数:**
+        - targets (list): 要压缩到的目标文件的路径。
+
+        **返回:**
+        - bool: 压缩成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().zip(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), targets
+        )
+
     def unzip(self, target: str, code: str = "utf-8") -> bool:
         """
         解压缩该 zip 文件到目标位置。
 
         **参数:**
-       <br> - target (str): 解压到的目标路径。
-       <br> - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。
+        - target (str): 解压到的目标路径。
+        - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。
             可选值: utf-8, gbk, big5
 
         **返回:**
-       <br> - bool: 解压成功后返回True。
+        - bool: 解压成功后返回True。
         """
         from mcsmapi.apis.file import File
 
@@ -83,15 +123,51 @@ class FileItem(BaseModel):
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target, code
         )
 
+    def update(self, text: str) -> bool:
+        """
+        更新该文件内容。
+        **参数:**
+        - text (str): 文件内容。
+        **返回:**
+        - bool: 更新成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().update(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), text
+        )
+
+    def download(self) -> str:
+        """
+        下载该文件。
+        **返回:**
+        - str: 文件下载的URL。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().download(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name)
+        )
+
 
 class FileList(BaseModel):
+    """文件列表"""
+
+    """文件信息列表"""
     items: List[FileItem]
+    """当前页数"""
     page: int = 0
+    """文件列表单页大小"""
     pageSize: int = 100
+    """总页数"""
     total: int = 0
+    """当前路径在远程节点的绝对路径"""
     absolutePath: str = "\\"
+    """远程节点uuid"""
     daemonId: str = ""
+    """实例uuid"""
     uuid: str = ""
+    """文件（名称或目录）路径"""
     target: str = ""
 
     def __init__(self, **data: str):
@@ -101,8 +177,52 @@ class FileList(BaseModel):
             item.uuid = self.uuid
             item.target = self.target
 
+    async def upload(self, file: bytes, upload_dir: str) -> bool:
+        """
+        上传文件到实例。
+
+        **参数:**
+        - file (bytes): 要上传的文件内容。
+        - upload_dir (str): 上传文件的目标目录(包含文件名)。
+
+        **返回:**
+        - bool: 返回操作结果，成功时返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return await File().upload(self.daemonId, self.uuid, file, upload_dir)
+
+    def createFile(self, target: str) -> bool:
+        """
+        创建文件。
+
+        **参数:**
+        - target (str): 目标文件的路径，包含文件名。
+
+        **返回:**
+        - bool: 创建成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().createFile(self.daemonId, self.uuid, target)
+
+    def createFloder(self, target: str) -> bool:
+        """
+        创建文件夹
+
+        **参数:**
+        - target (str): 目标文件夹的路径。
+
+        **返回:**
+        - bool: 创建成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().createFloder(self.daemonId, self.uuid, target)
 
 
 class CommonConfig(BaseModel):
+    """文件下载密码"""
     password: str = ""
+    """文件下载地址"""
     addr: str = ""