mcsmapi 0.1.4__tar.gz → 0.1.5b1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/PKG-INFO +1 -1
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/apis/daemon.py +9 -9
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/apis/file.py +70 -70
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/apis/image.py +13 -13
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/apis/instance.py +53 -53
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/apis/user.py +14 -14
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/models/daemon.py +9 -9
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/models/file.py +8 -8
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/models/instance.py +29 -12
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/models/user.py +3 -3
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi.egg-info/PKG-INFO +1 -1
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/pyproject.toml +1 -1
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/LICENSE +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/README.md +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/__init__.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/apis/__init__.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/apis/overview.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/exceptions.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/models/__init__.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/models/image.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/models/overview.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/pool.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi/request.py +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi.egg-info/SOURCES.txt +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi.egg-info/dependency_links.txt +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi.egg-info/requires.txt +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/mcsmapi.egg-info/top_level.txt +0 -0
- {mcsmapi-0.1.4 → mcsmapi-0.1.5b1}/setup.cfg +0 -0
@@ -10,10 +10,10 @@ class Daemon:
|
|
10
10
|
新增一个节点。
|
11
11
|
|
12
12
|
参数:
|
13
|
-
|
13
|
+
- config (dict): 节点的配置信息,以字典形式提供,缺失内容由DaemonConfig模型补全。
|
14
14
|
|
15
15
|
返回:
|
16
|
-
|
16
|
+
- str: 新增节点的ID
|
17
17
|
"""
|
18
18
|
return send(
|
19
19
|
"POST",
|
@@ -26,10 +26,10 @@ class Daemon:
|
|
26
26
|
删除一个节点。
|
27
27
|
|
28
28
|
参数:
|
29
|
-
|
29
|
+
- daemonId (str): 节点的唯一标识符。
|
30
30
|
|
31
31
|
返回:
|
32
|
-
|
32
|
+
- bool: 删除成功后返回True
|
33
33
|
"""
|
34
34
|
return send(
|
35
35
|
"DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
|
@@ -40,10 +40,10 @@ class Daemon:
|
|
40
40
|
连接一个节点。
|
41
41
|
|
42
42
|
参数:
|
43
|
-
|
43
|
+
- daemonId (str): 节点的唯一标识符。
|
44
44
|
|
45
45
|
返回:
|
46
|
-
|
46
|
+
- bool: 连接成功后返回True
|
47
47
|
"""
|
48
48
|
return send(
|
49
49
|
"GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
|
@@ -56,11 +56,11 @@ class Daemon:
|
|
56
56
|
**不建议直接使用此函数,建议调用overview()后在remote属性内使用updateConfig方法按需更新**
|
57
57
|
|
58
58
|
参数:
|
59
|
-
|
60
|
-
|
59
|
+
- daemonId (str): 节点的唯一标识符。
|
60
|
+
- config (dict): 节点的配置信息,以字典形式提供,缺失内容由DaemonConfig模型补全。
|
61
61
|
|
62
62
|
返回:
|
63
|
-
|
63
|
+
- bool: 更新成功后返回True
|
64
64
|
"""
|
65
65
|
return send(
|
66
66
|
"PUT",
|
@@ -18,14 +18,14 @@ class File:
|
|
18
18
|
获取文件列表
|
19
19
|
|
20
20
|
**参数:**
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
21
|
+
- daemonId (str): 守护进程的唯一标识符。
|
22
|
+
- uuid (str): 文件实例的唯一标识符。
|
23
|
+
- target (str, 可选): 用于文件过滤的目标路径。默认为空字符串,表示不按路径过滤。
|
24
|
+
- page (int, 可选): 指定分页的页码。默认为0。
|
25
|
+
- page_size (int, 可选): 指定每页的文件数量。默认为100。
|
26
26
|
|
27
27
|
**返回:**
|
28
|
-
|
28
|
+
- FileList: 包含文件列表信息和分页详情的FileList模型。
|
29
29
|
"""
|
30
30
|
result = send(
|
31
31
|
"GET",
|
@@ -45,12 +45,12 @@ class File:
|
|
45
45
|
获取文件内容
|
46
46
|
|
47
47
|
**参数:**
|
48
|
-
|
49
|
-
|
50
|
-
|
48
|
+
- daemonId (str): 守护进程的唯一标识符。
|
49
|
+
- uuid (str): 文件实例的唯一标识符。
|
50
|
+
- target (str): 文件的目标路径。
|
51
51
|
|
52
52
|
**返回:**
|
53
|
-
|
53
|
+
- str: 文件的内容信息。
|
54
54
|
"""
|
55
55
|
return send(
|
56
56
|
"PUT",
|
@@ -64,13 +64,13 @@ class File:
|
|
64
64
|
更新文件内容
|
65
65
|
|
66
66
|
**参数:**
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
67
|
+
- daemonId (str): 守护进程的唯一标识符。
|
68
|
+
- uuid (str): 文件实例的唯一标识符。
|
69
|
+
- target (str): 文件的目标路径。
|
70
|
+
- text (str): 新的文件内容。
|
71
71
|
|
72
72
|
**返回:**
|
73
|
-
|
73
|
+
- bool: 更新成功后返回True。
|
74
74
|
"""
|
75
75
|
return send(
|
76
76
|
"PUT",
|
@@ -84,12 +84,12 @@ class File:
|
|
84
84
|
下载文件
|
85
85
|
|
86
86
|
**参数:**
|
87
|
-
|
88
|
-
|
89
|
-
|
87
|
+
- daemonId (str): 守护进程的唯一标识符。
|
88
|
+
- uuid (str): 文件实例的唯一标识符。
|
89
|
+
- file_name (str): 要下载的文件名。路径+名字, 示例: /backup/world.zip
|
90
90
|
|
91
91
|
**返回:**
|
92
|
-
|
92
|
+
- str: 文件下载URL。
|
93
93
|
"""
|
94
94
|
|
95
95
|
result = send(
|
@@ -109,13 +109,13 @@ class File:
|
|
109
109
|
上传文件
|
110
110
|
|
111
111
|
**参数:**
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
112
|
+
- daemonId (str): 守护进程的唯一标识符。
|
113
|
+
- uuid (str): 文件实例的唯一标识符。
|
114
|
+
- file (bytes): 要上传的文件内容。
|
115
|
+
- upload_dir (str): 文件上传到的目标路径。
|
116
116
|
|
117
117
|
**返回:**
|
118
|
-
|
118
|
+
- bool: 上传成功后返回True。
|
119
119
|
"""
|
120
120
|
result = send(
|
121
121
|
"POST",
|
@@ -134,12 +134,12 @@ class File:
|
|
134
134
|
复制多个文件夹或文件到指定位置。
|
135
135
|
|
136
136
|
**参数:**
|
137
|
-
|
138
|
-
|
139
|
-
|
137
|
+
- daemonId (str): 守护进程的唯一标识符。
|
138
|
+
- uuid (str): 文件实例的唯一标识符。
|
139
|
+
- copy_map (dict): 复制映射,格式为 {源路径: 目标路径}
|
140
140
|
|
141
141
|
**返回:**
|
142
|
-
|
142
|
+
- bool: 上传成功后返回True。
|
143
143
|
"""
|
144
144
|
targets = [[source, target] for source, target in copy_map.items()]
|
145
145
|
return send(
|
@@ -154,13 +154,13 @@ class File:
|
|
154
154
|
复制单个文件或文件夹到指定位置。
|
155
155
|
|
156
156
|
**参数:**
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
157
|
+
- daemonId (str): 守护进程的唯一标识符。
|
158
|
+
- uuid (str): 实例的唯一标识符。
|
159
|
+
- source (str): 源文件或文件夹的路径。
|
160
|
+
- target (str): 目标文件或文件夹的路径。
|
161
161
|
|
162
162
|
**返回:**
|
163
|
-
|
163
|
+
- bool: 移动成功后返回True。
|
164
164
|
"""
|
165
165
|
return self.copy(daemonId, uuid, {source: target})
|
166
166
|
|
@@ -169,12 +169,12 @@ class File:
|
|
169
169
|
移动多个文件或文件夹到指定位置。
|
170
170
|
|
171
171
|
参数:
|
172
|
-
|
173
|
-
|
174
|
-
|
172
|
+
- daemonId (str): 守护进程的唯一标识符。
|
173
|
+
- uuid (str): 实例的唯一标识符。
|
174
|
+
- copy_map (dict): 移动映射,格式为 {源路径: 目标路径}
|
175
175
|
|
176
176
|
返回:
|
177
|
-
|
177
|
+
- bool: 移动成功后返回True。
|
178
178
|
"""
|
179
179
|
targets = [[source, target] for source, target in copy_map.items()]
|
180
180
|
return send(
|
@@ -189,13 +189,13 @@ class File:
|
|
189
189
|
从源路径移动单个文件或文件夹到目标路径。
|
190
190
|
|
191
191
|
参数:
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
192
|
+
- daemonId (str): 守护进程的唯一标识符。
|
193
|
+
- uuid (str): 实例的唯一标识符。
|
194
|
+
- source (str): 源文件或文件夹的路径。
|
195
|
+
- target (str): 目标文件或文件夹的路径。
|
196
196
|
|
197
197
|
返回:
|
198
|
-
|
198
|
+
- bool: 移动成功后返回True。
|
199
199
|
"""
|
200
200
|
return self.move(daemonId, uuid, {source: target})
|
201
201
|
|
@@ -204,13 +204,13 @@ class File:
|
|
204
204
|
重命名单个文件或文件夹。
|
205
205
|
|
206
206
|
**参数:**
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
207
|
+
- daemonId (str): 守护进程的唯一标识符。
|
208
|
+
- uuid (str): 实例的唯一标识符。
|
209
|
+
- source (str): 源文件或文件夹的路径。
|
210
|
+
- new_name (str): 源文件或文件夹的新名字。
|
211
211
|
|
212
212
|
**返回:**
|
213
|
-
|
213
|
+
- bool: 重命名成功后返回True。
|
214
214
|
"""
|
215
215
|
directory = os.path.dirname(source)
|
216
216
|
target = os.path.join(directory, new_name)
|
@@ -221,13 +221,13 @@ class File:
|
|
221
221
|
压缩多个文件或文件夹到指定位置。
|
222
222
|
|
223
223
|
**参数:**
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
224
|
+
- daemonId (str): 守护进程的唯一标识符。
|
225
|
+
- uuid (str): 实例的唯一标识符。
|
226
|
+
- source (str): 需要压缩到的 zip 文件路径。
|
227
|
+
- targets (list): 要压缩的目标文件或文件夹的路径。
|
228
228
|
|
229
229
|
**返回:**
|
230
|
-
|
230
|
+
- bool: 压缩成功后返回True。
|
231
231
|
"""
|
232
232
|
return send(
|
233
233
|
"POST",
|
@@ -243,15 +243,15 @@ class File:
|
|
243
243
|
解压缩指定的zip文件到目标位置。
|
244
244
|
|
245
245
|
**参数:**
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
246
|
+
- daemonId (str): 守护进程的唯一标识符。
|
247
|
+
- uuid (str): 实例的唯一标识符。
|
248
|
+
- source (str): 需要解压的zip文件路径。
|
249
|
+
- target (str): 解压到的目标路径。
|
250
|
+
- code (str, optional): 压缩文件的编码方式,默认为"utf-8"。
|
251
251
|
可选值: utf-8, gbk, big5
|
252
252
|
|
253
253
|
**返回:**
|
254
|
-
|
254
|
+
- bool: 解压成功后返回True。
|
255
255
|
"""
|
256
256
|
return send(
|
257
257
|
"POST",
|
@@ -265,12 +265,12 @@ class File:
|
|
265
265
|
删除多个文件或文件夹。
|
266
266
|
|
267
267
|
**参数:**
|
268
|
-
|
269
|
-
|
270
|
-
|
268
|
+
- daemonId (str): 守护进程的唯一标识符。
|
269
|
+
- uuid (str): 实例的唯一标识符。
|
270
|
+
- targets (list): 要删除的文件或文件夹的路径。
|
271
271
|
|
272
272
|
**返回:**
|
273
|
-
|
273
|
+
- bool: 删除成功后返回True。
|
274
274
|
"""
|
275
275
|
return send(
|
276
276
|
"DELETE",
|
@@ -284,12 +284,12 @@ class File:
|
|
284
284
|
创建文件。
|
285
285
|
|
286
286
|
**参数:**
|
287
|
-
|
288
|
-
|
289
|
-
|
287
|
+
- daemonId (str): 守护进程的唯一标识符。
|
288
|
+
- uuid (str): 实例的唯一标识符。
|
289
|
+
- target (str): 目标文件的路径,包含文件名。
|
290
290
|
|
291
291
|
**返回:**
|
292
|
-
|
292
|
+
- bool: 创建成功后返回True。
|
293
293
|
"""
|
294
294
|
return send(
|
295
295
|
"POST",
|
@@ -303,12 +303,12 @@ class File:
|
|
303
303
|
创建文件夹
|
304
304
|
|
305
305
|
**参数:**
|
306
|
-
|
307
|
-
|
308
|
-
|
306
|
+
- daemonId (str): 守护进程的唯一标识符。
|
307
|
+
- uuid (str): 实例的唯一标识符。
|
308
|
+
- target (str): 目标文件夹的路径。
|
309
309
|
|
310
310
|
**返回:**
|
311
|
-
|
311
|
+
- bool: 创建成功后返回True。
|
312
312
|
"""
|
313
313
|
return send(
|
314
314
|
"POST",
|
@@ -9,10 +9,10 @@ class Image:
|
|
9
9
|
获取镜像列表
|
10
10
|
|
11
11
|
**参数:**
|
12
|
-
|
12
|
+
- daemonId (str): 守护进程的唯一标识符。
|
13
13
|
|
14
14
|
**返回:**
|
15
|
-
|
15
|
+
- list[ImageModel]: 包含镜像列表详情的 ImageModel 模型的列表。
|
16
16
|
"""
|
17
17
|
result = send(
|
18
18
|
"GET",
|
@@ -29,10 +29,10 @@ class Image:
|
|
29
29
|
获取容器列表
|
30
30
|
|
31
31
|
**参数:**
|
32
|
-
|
32
|
+
- daemonId (str): 守护进程的唯一标识符。
|
33
33
|
|
34
34
|
**返回:**
|
35
|
-
|
35
|
+
- list[DockerContainerItem]: 包含容器列表详情的 DockerContainerItem 模型的列表。
|
36
36
|
"""
|
37
37
|
result = send(
|
38
38
|
"GET",
|
@@ -49,10 +49,10 @@ class Image:
|
|
49
49
|
获取网络接口列表
|
50
50
|
|
51
51
|
**参数:**
|
52
|
-
|
52
|
+
- daemonId (str): 守护进程的唯一标识符。
|
53
53
|
|
54
54
|
**返回:**
|
55
|
-
|
55
|
+
- list[DockerNetworkItem]: 包含网络接口列表详情的 DockerNetworkItem 模型的列表。
|
56
56
|
"""
|
57
57
|
result = send(
|
58
58
|
"GET",
|
@@ -68,13 +68,13 @@ class Image:
|
|
68
68
|
新增一个镜像
|
69
69
|
|
70
70
|
**参数:**
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
71
|
+
- daemonId (str): 守护进程的唯一标识符。
|
72
|
+
- dockerFile (str): DockerFile Config
|
73
|
+
- name (str): 镜像名称。
|
74
|
+
- tag (str): 镜像版本。
|
75
75
|
|
76
76
|
**返回:**
|
77
|
-
|
77
|
+
- bool: 新增镜像成功后返回True。
|
78
78
|
"""
|
79
79
|
return send(
|
80
80
|
"POST",
|
@@ -90,10 +90,10 @@ class Image:
|
|
90
90
|
## **由于文档此部分内容不详,未使用模型**
|
91
91
|
|
92
92
|
**参数:**
|
93
|
-
|
93
|
+
- daemonId (str): 守护进程的唯一标识符。
|
94
94
|
|
95
95
|
**返回:**
|
96
|
-
|
96
|
+
- dict[str, int]: 包含构建进度信息的字典。
|
97
97
|
"""
|
98
98
|
return send(
|
99
99
|
"GET",
|
@@ -23,15 +23,15 @@ class Instance:
|
|
23
23
|
根据指定的参数搜索实例信息
|
24
24
|
|
25
25
|
**参数:**
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
26
|
+
- daemonId (str): 守护进程的唯一标识符
|
27
|
+
- page (int): 页码,用于指示返回数据的页数。默认为1,表示返回第一页数据
|
28
|
+
- page_size (int): 每页大小,用于指定每页包含的数据条数。默认为20,表示每页包含20条数据
|
29
|
+
- instance_name (str): 实例的名称。默认为空字符串,表示不进行实例名称过滤
|
30
|
+
- status (str): 实例的状态。默认为空字符串,表示不进行状态过滤
|
31
|
+
- tag (list[str] | None): 实例的标签列表。默认为None,表示不进行标签过滤
|
32
32
|
|
33
33
|
**返回:**
|
34
|
-
|
34
|
+
- InstanceSearchList: 包含搜索结果的模型。该模型包含了符合搜索条件的实例信息列表,以及总数据条数、总页数等分页信息。
|
35
35
|
"""
|
36
36
|
if tag is None:
|
37
37
|
tag = []
|
@@ -54,11 +54,11 @@ class Instance:
|
|
54
54
|
获取指定实例的详细信息
|
55
55
|
|
56
56
|
**参数:**
|
57
|
-
|
58
|
-
|
57
|
+
- daemonId (str): 守护进程的唯一标识符
|
58
|
+
- uuid (str): 实例的唯一标识符
|
59
59
|
|
60
60
|
**返回:**
|
61
|
-
|
61
|
+
- InstanceDetail: 包含实例详细信息的模型。
|
62
62
|
"""
|
63
63
|
result = send(
|
64
64
|
"GET",
|
@@ -72,11 +72,11 @@ class Instance:
|
|
72
72
|
创建一个实例。
|
73
73
|
|
74
74
|
**参数:**
|
75
|
-
|
76
|
-
|
75
|
+
- daemonId (str): 守护进程的唯一标识符,用于关联新创建的实例。
|
76
|
+
- config (dict[str, Any]): 实例的配置信息,以字典形式提供,缺失内容由InstanceConfig模型补全。
|
77
77
|
|
78
78
|
**返回:**
|
79
|
-
|
79
|
+
- InstanceCreateResult: 一个包含新创建实例信息的结果对象,内容由InstanceCreateResult模型定义。
|
80
80
|
"""
|
81
81
|
result = send(
|
82
82
|
"POST",
|
@@ -93,12 +93,12 @@ class Instance:
|
|
93
93
|
**不建议直接使用此函数,建议调用search后在data属性内使用updateConfig方法按需更新**
|
94
94
|
|
95
95
|
**参数:**
|
96
|
-
|
97
|
-
|
98
|
-
|
96
|
+
- daemonId (str): 守护进程的标识符。
|
97
|
+
- uuid (str): 实例的唯一标识符。
|
98
|
+
- config (dict): 新的实例配置,以字典形式提供,缺失内容由InstanceConfig模型补全。
|
99
99
|
|
100
100
|
**返回:**
|
101
|
-
|
101
|
+
- str|bool: 更新成功后返回更新的实例UUID,如果未找到该字段,则默认返回True。
|
102
102
|
"""
|
103
103
|
result = send(
|
104
104
|
"PUT",
|
@@ -115,12 +115,12 @@ class Instance:
|
|
115
115
|
删除实例。
|
116
116
|
|
117
117
|
**参数:**
|
118
|
-
|
119
|
-
|
120
|
-
|
118
|
+
- daemonId (str): 守护进程的标识符。
|
119
|
+
- uuids (list): 要删除的实例UUID列表。
|
120
|
+
- deleteFile (bool, optional): 是否删除关联的文件,默认为False。
|
121
121
|
|
122
122
|
**返回:**
|
123
|
-
|
123
|
+
- list[str]: 删除操作后返回的UUID列表。
|
124
124
|
"""
|
125
125
|
return send(
|
126
126
|
"DELETE",
|
@@ -134,11 +134,11 @@ class Instance:
|
|
134
134
|
启动实例。
|
135
135
|
|
136
136
|
**参数:**
|
137
|
-
|
138
|
-
|
137
|
+
- daemonId (str): 守护进程的ID,用于标识特定的守护进程。
|
138
|
+
- uuid (str): 实例的唯一标识符,用于指定需要启动的实例。
|
139
139
|
|
140
140
|
**返回:**
|
141
|
-
|
141
|
+
- str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
142
142
|
"""
|
143
143
|
result = send(
|
144
144
|
"GET",
|
@@ -152,11 +152,11 @@ class Instance:
|
|
152
152
|
关闭实例。
|
153
153
|
|
154
154
|
**参数:**
|
155
|
-
|
156
|
-
|
155
|
+
- daemonId (str): 守护进程的ID,用于标识特定的守护进程。
|
156
|
+
- uuid (str): 实例的唯一标识符,用于指定需要关闭的实例。
|
157
157
|
|
158
158
|
**返回:**
|
159
|
-
|
159
|
+
- str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
160
160
|
"""
|
161
161
|
result = send(
|
162
162
|
"GET",
|
@@ -170,11 +170,11 @@ class Instance:
|
|
170
170
|
重启实例。
|
171
171
|
|
172
172
|
**参数:**
|
173
|
-
|
174
|
-
|
173
|
+
- daemonId (str): 守护进程的ID,用于标识特定的守护进程。
|
174
|
+
- uuid (str): 实例的唯一标识符,用于指定需要重启的实例。
|
175
175
|
|
176
176
|
**返回:**
|
177
|
-
|
177
|
+
- str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
178
178
|
"""
|
179
179
|
result = send(
|
180
180
|
"GET",
|
@@ -188,11 +188,11 @@ class Instance:
|
|
188
188
|
强制关闭实例。
|
189
189
|
|
190
190
|
**参数:**
|
191
|
-
|
192
|
-
|
191
|
+
- daemonId (str): 守护进程的ID,用于标识特定的守护进程。
|
192
|
+
- uuid (str): 实例的唯一标识符,用于指定需要强制关闭的实例。
|
193
193
|
|
194
194
|
**返回:**
|
195
|
-
|
195
|
+
- str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
196
196
|
"""
|
197
197
|
result = send(
|
198
198
|
"GET",
|
@@ -206,11 +206,11 @@ class Instance:
|
|
206
206
|
对多个实例进行批量操作。
|
207
207
|
|
208
208
|
**参数:**
|
209
|
-
|
210
|
-
|
209
|
+
- instances (list[dict[str,str]]): 包含多个实例信息的列表,每个实例信息为一个字典,包含 "uuid" 和 "daemonId" 字段。
|
210
|
+
- operation (str): 要执行的操作,可以是 "start", "stop", "restart", 或 "kill"。
|
211
211
|
|
212
212
|
**返回:**
|
213
|
-
|
213
|
+
- list[dict[str,str]]:包含每个实例操作结果的列表,每个结果为一个字典,包含 "uuid" 和 "result" 字段。
|
214
214
|
"""
|
215
215
|
if operation in {"start", "stop", "restart", "kill"}:
|
216
216
|
return send("POST", f"{ApiPool.INSTANCE}/multi_{operation}", data=instances)
|
@@ -222,11 +222,11 @@ class Instance:
|
|
222
222
|
升级实例。
|
223
223
|
|
224
224
|
**参数:**
|
225
|
-
|
226
|
-
|
225
|
+
- daemonId (str): 守护进程的ID,用于标识特定的守护进程。
|
226
|
+
- uuid (str): 实例的唯一标识符,用于指定需要升级的实例。
|
227
227
|
|
228
228
|
**返回:**
|
229
|
-
|
229
|
+
- bool: 返回操作结果,成功时返回True。
|
230
230
|
"""
|
231
231
|
return send(
|
232
232
|
"GET",
|
@@ -239,12 +239,12 @@ class Instance:
|
|
239
239
|
向实例发送命令。
|
240
240
|
|
241
241
|
**参数:**
|
242
|
-
|
243
|
-
|
244
|
-
|
242
|
+
- daemonId (str): 守护进程的ID,用于标识特定的守护进程。
|
243
|
+
- uuid (str): 实例的唯一标识符,用于指定需要发送命令的实例。
|
244
|
+
- command (str): 要发送的命令。
|
245
245
|
|
246
246
|
**返回:**
|
247
|
-
|
247
|
+
- str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
248
248
|
"""
|
249
249
|
result = send(
|
250
250
|
"GET",
|
@@ -258,12 +258,12 @@ class Instance:
|
|
258
258
|
获取实例输出。
|
259
259
|
|
260
260
|
**参数:**
|
261
|
-
|
262
|
-
|
263
|
-
|
261
|
+
- daemonId (str): 守护进程的ID,用于标识特定的守护进程。
|
262
|
+
- uuid (str): 实例的唯一标识符,用于指定需要获取输出的实例。
|
263
|
+
- size (int, optional): 获取的日志大小: 1KB ~ 2048KB,如果未设置,则返回所有日志
|
264
264
|
|
265
265
|
**返回:**
|
266
|
-
|
266
|
+
- str: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
267
267
|
"""
|
268
268
|
return send(
|
269
269
|
"GET",
|
@@ -283,14 +283,14 @@ class Instance:
|
|
283
283
|
重装实例。
|
284
284
|
|
285
285
|
**参数:**
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
286
|
+
- daemonId (str): 守护进程的ID,用于标识特定的守护进程。
|
287
|
+
- uuid (str): 实例的唯一标识符。
|
288
|
+
- targetUrl (str): 重装文件的目标URL。
|
289
|
+
- title (str): 重装文件的标题。
|
290
|
+
- description (str, optional): 重装文件的描述,默认为空字符串。
|
291
291
|
|
292
292
|
**返回:**
|
293
|
-
|
293
|
+
- bool: 返回操作结果,成功时返回True。
|
294
294
|
"""
|
295
295
|
return send(
|
296
296
|
"POST",
|
@@ -11,14 +11,14 @@ class User:
|
|
11
11
|
"""根据用户名和角色搜索用户信息
|
12
12
|
|
13
13
|
**参数:**
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
14
|
+
- username (str): 要搜索的用户名。默认为空字符串,表示不进行用户名过滤
|
15
|
+
- page (int): 页码,用于指示返回数据的页数。默认为1,表示返回第一页数据
|
16
|
+
- page_size (int): 每页大小,用于指定每页包含的数据条数。默认为20,表示每页包含20条数据
|
17
|
+
- role (str): 用户权限。默认为空字符串,表示不进行权限过滤
|
18
18
|
可用的值为 1=用户, 10=管理员, -1=被封禁的用户
|
19
19
|
|
20
20
|
**返回:**
|
21
|
-
|
21
|
+
- SearchUserModel: 包含搜索结果的模型。该模型包含了符合搜索条件的用户信息列表,以及总数据条数、总页数等分页信息。
|
22
22
|
"""
|
23
23
|
result = send(
|
24
24
|
"GET",
|
@@ -37,12 +37,12 @@ class User:
|
|
37
37
|
创建新用户的方法
|
38
38
|
|
39
39
|
**参数:**
|
40
|
-
|
41
|
-
|
42
|
-
|
40
|
+
- username (str): 用户名,字符串类型
|
41
|
+
- password (str): 密码,字符串类型
|
42
|
+
- permission (int): 权限等级,整数类型,默认值为1
|
43
43
|
|
44
44
|
**返回:**
|
45
|
-
|
45
|
+
- str|bool: 创建成功后返回用户的UUID,如果未找到该字段,则默认返回True。
|
46
46
|
"""
|
47
47
|
return send(
|
48
48
|
"POST",
|
@@ -57,11 +57,11 @@ class User:
|
|
57
57
|
**不建议直接使用此函数,建议调用search后使用update方法按需更新**
|
58
58
|
|
59
59
|
**参数:**
|
60
|
-
|
61
|
-
|
60
|
+
- uuid (str): 用户的唯一标识符UUID
|
61
|
+
- config (dict[str, Any]): 新的用户信息,以字典形式提供,缺失内容由UserConfig模型补全。
|
62
62
|
|
63
63
|
**返回:**
|
64
|
-
|
64
|
+
- bool: 成功时返回True
|
65
65
|
"""
|
66
66
|
return send(
|
67
67
|
"PUT",
|
@@ -74,9 +74,9 @@ class User:
|
|
74
74
|
删除用户的方法
|
75
75
|
|
76
76
|
**参数:**
|
77
|
-
|
77
|
+
- uuids (list[str]): 包含要删除的用户UUID的列表。
|
78
78
|
|
79
79
|
**返回:**
|
80
|
-
|
80
|
+
- bool: 成功时返回True
|
81
81
|
"""
|
82
82
|
return send("DELETE", ApiPool.AUTH, data=uuids)
|
@@ -53,7 +53,7 @@ class DaemonModel(BaseModel):
|
|
53
53
|
删除该节点。
|
54
54
|
|
55
55
|
返回:
|
56
|
-
|
56
|
+
- bool: 删除成功后返回True
|
57
57
|
"""
|
58
58
|
from mcsmapi.apis.daemon import Daemon
|
59
59
|
|
@@ -64,7 +64,7 @@ class DaemonModel(BaseModel):
|
|
64
64
|
链接该节点。
|
65
65
|
|
66
66
|
返回:
|
67
|
-
|
67
|
+
- bool: 链接成功后返回True
|
68
68
|
"""
|
69
69
|
from mcsmapi.apis.daemon import Daemon
|
70
70
|
|
@@ -75,10 +75,10 @@ class DaemonModel(BaseModel):
|
|
75
75
|
更新该节点的配置。
|
76
76
|
|
77
77
|
参数:
|
78
|
-
|
78
|
+
- config (dict[str, Any]): 节点的配置信息,以字典形式提供,缺失内容使用原节点配置填充。
|
79
79
|
|
80
80
|
返回:
|
81
|
-
|
81
|
+
- bool: 更新成功后返回True
|
82
82
|
"""
|
83
83
|
from mcsmapi.apis.daemon import Daemon
|
84
84
|
|
@@ -100,10 +100,10 @@ class DaemonModel(BaseModel):
|
|
100
100
|
在当前节点创建一个实例。
|
101
101
|
|
102
102
|
参数:
|
103
|
-
|
103
|
+
- config (dict[str, Any]): 实例的配置信息,以字典形式提供,缺失内容由InstanceConfig模型补全。
|
104
104
|
|
105
105
|
返回:
|
106
|
-
|
106
|
+
- InstanceCreateResult: 一个包含新创建实例信息的结果对象,内容由InstanceCreateResult模型定义。
|
107
107
|
"""
|
108
108
|
from mcsmapi.apis.instance import Instance
|
109
109
|
from .instance import InstanceConfig
|
@@ -115,11 +115,11 @@ class DaemonModel(BaseModel):
|
|
115
115
|
删除当前节点的一个或多个实例。
|
116
116
|
|
117
117
|
参数:
|
118
|
-
|
119
|
-
|
118
|
+
- uuids (list[str]): 要删除的实例UUID列表。
|
119
|
+
- deleteFile (bool, optional): 是否删除关联的文件,默认为False。
|
120
120
|
|
121
121
|
返回:
|
122
|
-
|
122
|
+
- list[str]: 删除操作后返回的UUID列表。
|
123
123
|
"""
|
124
124
|
from mcsmapi.apis.instance import Instance
|
125
125
|
|
@@ -18,10 +18,10 @@ class FileItem(BaseModel):
|
|
18
18
|
重命名该文件或文件夹。
|
19
19
|
|
20
20
|
**参数:**
|
21
|
-
|
21
|
+
- new_name (str): 源文件或文件夹的新名字。
|
22
22
|
|
23
23
|
**返回:**
|
24
|
-
|
24
|
+
- bool: 重命名成功后返回True。
|
25
25
|
"""
|
26
26
|
from mcsmapi.apis.file import File
|
27
27
|
|
@@ -34,7 +34,7 @@ class FileItem(BaseModel):
|
|
34
34
|
删除该文件或文件夹。
|
35
35
|
|
36
36
|
**返回:**
|
37
|
-
|
37
|
+
- bool: 重命名成功后返回True。
|
38
38
|
"""
|
39
39
|
from mcsmapi.apis.file import File
|
40
40
|
|
@@ -54,10 +54,10 @@ class FileItem(BaseModel):
|
|
54
54
|
移动该文件或文件夹到目标路径。
|
55
55
|
|
56
56
|
**参数:**
|
57
|
-
|
57
|
+
- target (str): 目标文件或文件夹的路径。
|
58
58
|
|
59
59
|
**返回:**
|
60
|
-
|
60
|
+
- bool: 移动成功后返回True。
|
61
61
|
"""
|
62
62
|
from mcsmapi.apis.file import File
|
63
63
|
|
@@ -70,12 +70,12 @@ class FileItem(BaseModel):
|
|
70
70
|
解压缩该 zip 文件到目标位置。
|
71
71
|
|
72
72
|
**参数:**
|
73
|
-
|
74
|
-
|
73
|
+
- target (str): 解压到的目标路径。
|
74
|
+
- code (str, optional): 压缩文件的编码方式,默认为"utf-8"。
|
75
75
|
可选值: utf-8, gbk, big5
|
76
76
|
|
77
77
|
**返回:**
|
78
|
-
|
78
|
+
- bool: 解压成功后返回True。
|
79
79
|
"""
|
80
80
|
from mcsmapi.apis.file import File
|
81
81
|
|
@@ -1,5 +1,6 @@
|
|
1
1
|
from typing import List, Dict, Optional
|
2
2
|
from pydantic import BaseModel
|
3
|
+
from mcsmapi.models.file import FileList
|
3
4
|
from mcsmapi.models.image import DockerConfig
|
4
5
|
|
5
6
|
|
@@ -81,7 +82,7 @@ class InstanceDetail(BaseModel):
|
|
81
82
|
启动该实例。
|
82
83
|
|
83
84
|
**返回:**
|
84
|
-
|
85
|
+
- str|bool: str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
85
86
|
"""
|
86
87
|
from mcsmapi.apis.instance import Instance
|
87
88
|
|
@@ -92,7 +93,7 @@ class InstanceDetail(BaseModel):
|
|
92
93
|
停止该实例。
|
93
94
|
|
94
95
|
**返回:**
|
95
|
-
|
96
|
+
- str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
96
97
|
"""
|
97
98
|
from mcsmapi.apis.instance import Instance
|
98
99
|
|
@@ -103,7 +104,7 @@ class InstanceDetail(BaseModel):
|
|
103
104
|
重启该实例。
|
104
105
|
|
105
106
|
**返回:**
|
106
|
-
|
107
|
+
- str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
107
108
|
"""
|
108
109
|
from mcsmapi.apis.instance import Instance
|
109
110
|
|
@@ -114,7 +115,7 @@ class InstanceDetail(BaseModel):
|
|
114
115
|
强制关闭该实例。
|
115
116
|
|
116
117
|
**返回:**
|
117
|
-
|
118
|
+
- str|bool: 返回结果中的 "instanceUuid" 字段值,如果未找到该字段,则默认返回True。
|
118
119
|
"""
|
119
120
|
from mcsmapi.apis.instance import Instance
|
120
121
|
|
@@ -125,7 +126,7 @@ class InstanceDetail(BaseModel):
|
|
125
126
|
删除该实例。
|
126
127
|
|
127
128
|
**返回:**
|
128
|
-
|
129
|
+
- str: 被删除的实例的uuid。
|
129
130
|
"""
|
130
131
|
from mcsmapi.apis.instance import Instance
|
131
132
|
|
@@ -136,7 +137,7 @@ class InstanceDetail(BaseModel):
|
|
136
137
|
升级实例。
|
137
138
|
|
138
139
|
**返回:**
|
139
|
-
|
140
|
+
- bool: 返回操作结果,成功时返回True。
|
140
141
|
"""
|
141
142
|
from mcsmapi.apis.instance import Instance
|
142
143
|
|
@@ -147,10 +148,10 @@ class InstanceDetail(BaseModel):
|
|
147
148
|
更新该实例配置。
|
148
149
|
|
149
150
|
**参数:**
|
150
|
-
|
151
|
+
- config (dict): 新的实例配置,以字典形式提供,缺失内容由使用原实例配置填充。
|
151
152
|
|
152
153
|
**返回:**
|
153
|
-
|
154
|
+
- str|bool: 更新成功后返回更新的实例UUID,如果未找到该字段,则默认返回True。
|
154
155
|
"""
|
155
156
|
from mcsmapi.apis.instance import Instance
|
156
157
|
|
@@ -168,12 +169,12 @@ class InstanceDetail(BaseModel):
|
|
168
169
|
重装实例。
|
169
170
|
|
170
171
|
**参数:**
|
171
|
-
|
172
|
-
|
173
|
-
|
172
|
+
- targetUrl (str): 重装文件的目标URL。
|
173
|
+
- title (str): 重装文件的标题。
|
174
|
+
- description (str, optional): 重装文件的描述,默认为空字符串。
|
174
175
|
|
175
176
|
**返回:**
|
176
|
-
|
177
|
+
- bool: 返回操作结果,成功时返回True
|
177
178
|
"""
|
178
179
|
from mcsmapi.apis.instance import Instance
|
179
180
|
|
@@ -181,6 +182,22 @@ class InstanceDetail(BaseModel):
|
|
181
182
|
self.daemonId, self.instanceUuid, targetUrl, title, description
|
182
183
|
)
|
183
184
|
|
185
|
+
def files(self, target:str = "", page:int=0, page_size:int=100) -> FileList:
|
186
|
+
"""
|
187
|
+
获取实例的文件列表。
|
188
|
+
|
189
|
+
**参数:**
|
190
|
+
- target (str, 可选): 用于文件过滤的目标路径。默认为空字符串,表示不按路径过滤
|
191
|
+
- page (int, 可选): 指定分页的页码。默认为0。
|
192
|
+
- page_size (int, 可选): 指定每页的文件数量。默认为100。
|
193
|
+
|
194
|
+
**返回:**
|
195
|
+
- FileList: 文件列表。
|
196
|
+
"""
|
197
|
+
from mcsmapi.apis.file import File
|
198
|
+
|
199
|
+
return File().show(self.daemonId, self.instanceUuid, target, page, page_size)
|
200
|
+
|
184
201
|
|
185
202
|
class InstanceCreateResult(BaseModel):
|
186
203
|
instanceUuid: str = ""
|
@@ -23,7 +23,7 @@ class UserModel(BaseModel):
|
|
23
23
|
删除该用户。
|
24
24
|
|
25
25
|
**返回:**
|
26
|
-
|
26
|
+
- bool: 删除成功后返回True。
|
27
27
|
"""
|
28
28
|
from mcsmapi.apis.user import User
|
29
29
|
|
@@ -34,10 +34,10 @@ class UserModel(BaseModel):
|
|
34
34
|
更新该用户的信息。
|
35
35
|
|
36
36
|
参数:
|
37
|
-
|
37
|
+
- config (dict[str, Any]): 用户的新信息,以字典形式提供,缺失内容使用原用户信息填充。
|
38
38
|
|
39
39
|
返回:
|
40
|
-
|
40
|
+
- bool: 更新成功后返回True。
|
41
41
|
"""
|
42
42
|
from mcsmapi.apis.user import User
|
43
43
|
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|