tccli 3.0.848.1__py2.py3-none-any.whl → 3.0.849.1__py2.py3-none-any.whl

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.
@@ -0,0 +1,2414 @@
1
+ {
2
+ "actions": {
3
+ "AddClusterStorageOption": {
4
+ "document": "本接口(AddClusterStorageOption)用于添加集群存储选项信息。",
5
+ "input": "AddClusterStorageOptionRequest",
6
+ "name": "添加集群存储选项",
7
+ "output": "AddClusterStorageOptionResponse",
8
+ "status": "online"
9
+ },
10
+ "AddNodes": {
11
+ "document": "本接口(AddNodes)用于添加一个或者多个计算节点或者登录节点到指定集群。",
12
+ "input": "AddNodesRequest",
13
+ "name": "添加节点",
14
+ "output": "AddNodesResponse",
15
+ "status": "online"
16
+ },
17
+ "AddQueue": {
18
+ "document": "本接口(AddQueue)用于添加队列到指定集群。\n* 本接口为目前只支持SchedulerType为SLURM的集群。\n* 单个集群中队列数量上限为10个。",
19
+ "input": "AddQueueRequest",
20
+ "name": "添加队列",
21
+ "output": "AddQueueResponse",
22
+ "status": "online"
23
+ },
24
+ "CreateCluster": {
25
+ "document": "本接口 (CreateCluster) 用于创建并启动集群。\n\n* 本接口为异步接口, 当创建集群请求下发成功后会返回一个集群`ID`和一个`RequestId`,此时创建集群操作并未立即完成。在此期间集群的状态将会处于“PENDING”或者“INITING”,集群创建结果可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/1527/72100) 接口查询,如果集群状态(ClusterStatus)变为“RUNNING(运行中)”,则代表集群创建成功,“ INIT_FAILED”代表集群创建失败。",
26
+ "input": "CreateClusterRequest",
27
+ "name": "创建集群",
28
+ "output": "CreateClusterResponse",
29
+ "status": "online"
30
+ },
31
+ "DeleteCluster": {
32
+ "document": "本接口(DeleteCluster)用于删除一个指定的集群。",
33
+ "input": "DeleteClusterRequest",
34
+ "name": "删除集群",
35
+ "output": "DeleteClusterResponse",
36
+ "status": "online"
37
+ },
38
+ "DeleteClusterStorageOption": {
39
+ "document": "本接口 (DeleteClusterStorageOption) 用于删除集群存储选项信息。",
40
+ "input": "DeleteClusterStorageOptionRequest",
41
+ "name": "删除集群存储选项",
42
+ "output": "DeleteClusterStorageOptionResponse",
43
+ "status": "online"
44
+ },
45
+ "DeleteNodes": {
46
+ "document": "本接口(DeleteNodes)用于删除指定集群中一个或者多个计算节点或者登录节点。",
47
+ "input": "DeleteNodesRequest",
48
+ "name": "删除节点",
49
+ "output": "DeleteNodesResponse",
50
+ "status": "online"
51
+ },
52
+ "DeleteQueue": {
53
+ "document": "本接口(DeleteQueue)用于从指定集群删除队列。\n* 本接口为目前只支持SchedulerType为SLURM的集群。\n\n* 删除队列时,需要保证队列内不存在节点。",
54
+ "input": "DeleteQueueRequest",
55
+ "name": "删除队列",
56
+ "output": "DeleteQueueResponse",
57
+ "status": "online"
58
+ },
59
+ "DescribeAutoScalingConfiguration": {
60
+ "document": "本接口(DescribeAutoScalingConfiguration)用于查询集群弹性伸缩配置信息。本接口仅适用于弹性伸缩类型为THPC_AS的集群。",
61
+ "input": "DescribeAutoScalingConfigurationRequest",
62
+ "name": "查询弹性伸缩配置信息",
63
+ "output": "DescribeAutoScalingConfigurationResponse",
64
+ "status": "online"
65
+ },
66
+ "DescribeClusterActivities": {
67
+ "document": "本接口(DescribeClusterActivities)用于查询集群活动历史记录列表。",
68
+ "input": "DescribeClusterActivitiesRequest",
69
+ "name": "查询集群活动历史记录",
70
+ "output": "DescribeClusterActivitiesResponse",
71
+ "status": "online"
72
+ },
73
+ "DescribeClusterStorageOption": {
74
+ "document": "本接口 (DescribeClusterStorageOption) 用于查询集群存储选项信息。",
75
+ "input": "DescribeClusterStorageOptionRequest",
76
+ "name": "查询集群存储选项",
77
+ "output": "DescribeClusterStorageOptionResponse",
78
+ "status": "online"
79
+ },
80
+ "DescribeClusters": {
81
+ "document": "本接口(DescribeClusters)用于查询集群列表。",
82
+ "input": "DescribeClustersRequest",
83
+ "name": "查询集群列表",
84
+ "output": "DescribeClustersResponse",
85
+ "status": "online"
86
+ },
87
+ "DescribeNodes": {
88
+ "document": "本接口 (DescribeNodes) 用于查询指定集群节点概览信息列表。",
89
+ "input": "DescribeNodesRequest",
90
+ "name": "查询指定集群节点列表",
91
+ "output": "DescribeNodesResponse",
92
+ "status": "online"
93
+ },
94
+ "DescribeQueues": {
95
+ "document": "本接口(DescribeQueues)用于查询指定集群队列概览信息列表。",
96
+ "input": "DescribeQueuesRequest",
97
+ "name": "查询队列列表",
98
+ "output": "DescribeQueuesResponse",
99
+ "status": "online"
100
+ },
101
+ "SetAutoScalingConfiguration": {
102
+ "document": "本接口(SetAutoScalingConfiguration)用于为集群设置集群弹性伸缩配置信息。",
103
+ "input": "SetAutoScalingConfigurationRequest",
104
+ "name": "设置弹性伸缩配置信息",
105
+ "output": "SetAutoScalingConfigurationResponse",
106
+ "status": "online"
107
+ }
108
+ },
109
+ "metadata": {
110
+ "apiVersion": "2023-03-21",
111
+ "api_brief": "THPC一期可实现固定集群的创建,暂不支持弹性扩容。",
112
+ "serviceNameCN": "高性能计算平台",
113
+ "serviceShortName": "thpc"
114
+ },
115
+ "objects": {
116
+ "AddClusterStorageOptionRequest": {
117
+ "document": "AddClusterStorageOption请求参数结构体",
118
+ "members": [
119
+ {
120
+ "document": "集群ID。",
121
+ "example": "hpc-5lyv94lq",
122
+ "member": "string",
123
+ "name": "ClusterId",
124
+ "required": true,
125
+ "type": "string"
126
+ },
127
+ {
128
+ "document": "集群存储选项。",
129
+ "example": "无",
130
+ "member": "StorageOption",
131
+ "name": "StorageOption",
132
+ "required": true,
133
+ "type": "object"
134
+ }
135
+ ],
136
+ "type": "object"
137
+ },
138
+ "AddClusterStorageOptionResponse": {
139
+ "document": "AddClusterStorageOption返回参数结构体",
140
+ "members": [
141
+ {
142
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
143
+ "member": "string",
144
+ "name": "RequestId",
145
+ "type": "string"
146
+ }
147
+ ],
148
+ "type": "object"
149
+ },
150
+ "AddNodesRequest": {
151
+ "document": "AddNodes请求参数结构体",
152
+ "members": [
153
+ {
154
+ "document": "集群中实例所在的位置。",
155
+ "example": "无",
156
+ "member": "Placement",
157
+ "name": "Placement",
158
+ "required": true,
159
+ "type": "object"
160
+ },
161
+ {
162
+ "document": "集群ID。",
163
+ "example": "无",
164
+ "member": "string",
165
+ "name": "ClusterId",
166
+ "required": true,
167
+ "type": "string"
168
+ },
169
+ {
170
+ "document": "私有网络相关信息配置。",
171
+ "example": "无",
172
+ "member": "VirtualPrivateCloud",
173
+ "name": "VirtualPrivateCloud",
174
+ "required": true,
175
+ "type": "object"
176
+ },
177
+ {
178
+ "document": "添加节点数量。",
179
+ "example": "无",
180
+ "member": "int64",
181
+ "name": "Count",
182
+ "required": true,
183
+ "type": "int"
184
+ },
185
+ {
186
+ "document": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜像和特定自定义镜像。",
187
+ "example": "无",
188
+ "member": "string",
189
+ "name": "ImageId",
190
+ "required": false,
191
+ "type": "string"
192
+ },
193
+ {
194
+ "document": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月<br><li>POSTPAID_BY_HOUR:按小时后付费<br><li>SPOTPAID:竞价付费<br>默认值:POSTPAID_BY_HOUR。",
195
+ "example": "无",
196
+ "member": "string",
197
+ "name": "InstanceChargeType",
198
+ "required": false,
199
+ "type": "string"
200
+ },
201
+ {
202
+ "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。",
203
+ "example": "无",
204
+ "member": "InstanceChargePrepaid",
205
+ "name": "InstanceChargePrepaid",
206
+ "required": false,
207
+ "type": "object"
208
+ },
209
+ {
210
+ "document": "节点机型。不同实例机型指定了不同的资源规格。<br><li>具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。",
211
+ "example": "无",
212
+ "member": "string",
213
+ "name": "InstanceType",
214
+ "required": false,
215
+ "type": "string"
216
+ },
217
+ {
218
+ "document": "节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。",
219
+ "example": "无",
220
+ "member": "SystemDisk",
221
+ "name": "SystemDisk",
222
+ "required": false,
223
+ "type": "object"
224
+ },
225
+ {
226
+ "document": "节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。",
227
+ "example": "无",
228
+ "member": "DataDisk",
229
+ "name": "DataDisks",
230
+ "required": false,
231
+ "type": "list"
232
+ },
233
+ {
234
+ "document": "公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。",
235
+ "example": "无",
236
+ "member": "InternetAccessible",
237
+ "name": "InternetAccessible",
238
+ "required": false,
239
+ "type": "object"
240
+ },
241
+ {
242
+ "document": "节点显示名称。\n不指定节点显示名称则默认显示‘未命名’。\n最多支持60个字符。",
243
+ "example": "无",
244
+ "member": "string",
245
+ "name": "InstanceName",
246
+ "required": false,
247
+ "type": "string"
248
+ },
249
+ {
250
+ "document": "集群登录设置。",
251
+ "example": "无",
252
+ "member": "LoginSettings",
253
+ "name": "LoginSettings",
254
+ "required": false,
255
+ "type": "object"
256
+ },
257
+ {
258
+ "document": "集群中实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。",
259
+ "example": "无",
260
+ "member": "string",
261
+ "name": "SecurityGroupIds",
262
+ "required": false,
263
+ "type": "list"
264
+ },
265
+ {
266
+ "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。",
267
+ "example": "无",
268
+ "member": "string",
269
+ "name": "ClientToken",
270
+ "required": false,
271
+ "type": "string"
272
+ },
273
+ {
274
+ "document": "队列名称。不指定则为默认队列。<li>SLURM默认队列为:compute。<li>SGE默认队列为:all.q。\n",
275
+ "example": "无",
276
+ "member": "string",
277
+ "name": "QueueName",
278
+ "required": false,
279
+ "type": "string"
280
+ },
281
+ {
282
+ "document": "添加节点角色。默认值:Compute<br><li>Compute:计算节点。<br><li>Login:登录节点。",
283
+ "example": "无",
284
+ "member": "string",
285
+ "name": "NodeRole",
286
+ "required": false,
287
+ "type": "string"
288
+ },
289
+ {
290
+ "document": "是否只预检此次请求。\ntrue:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。\n如果检查不通过,则返回对应错误码;\n如果检查通过,则返回RequestId.\nfalse(默认):发送正常请求,通过检查后直接创建实例",
291
+ "example": "无",
292
+ "member": "bool",
293
+ "name": "DryRun",
294
+ "required": false,
295
+ "type": "bool"
296
+ },
297
+ {
298
+ "document": "添加节点类型。默认取值:STATIC。<li>STATIC:静态节点,不会参与弹性伸缩流程。<li>DYNAMIC:弹性节点,会被弹性缩容的节点。管控节点和登录节点不支持此参数。",
299
+ "example": "无",
300
+ "member": "string",
301
+ "name": "NodeType",
302
+ "required": false,
303
+ "type": "string"
304
+ }
305
+ ],
306
+ "type": "object"
307
+ },
308
+ "AddNodesResponse": {
309
+ "document": "AddNodes返回参数结构体",
310
+ "members": [
311
+ {
312
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
313
+ "member": "string",
314
+ "name": "RequestId",
315
+ "type": "string"
316
+ }
317
+ ],
318
+ "type": "object"
319
+ },
320
+ "AddQueueRequest": {
321
+ "document": "AddQueue请求参数结构体",
322
+ "members": [
323
+ {
324
+ "document": "集群ID。",
325
+ "example": "hpc-prkxbd7c",
326
+ "member": "string",
327
+ "name": "ClusterId",
328
+ "required": true,
329
+ "type": "string"
330
+ },
331
+ {
332
+ "document": "队列名称。<br><li>最多支持32个字符。",
333
+ "example": "compute",
334
+ "member": "string",
335
+ "name": "QueueName",
336
+ "required": true,
337
+ "type": "string"
338
+ }
339
+ ],
340
+ "type": "object"
341
+ },
342
+ "AddQueueResponse": {
343
+ "document": "AddQueue返回参数结构体",
344
+ "members": [
345
+ {
346
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
347
+ "member": "string",
348
+ "name": "RequestId",
349
+ "type": "string"
350
+ }
351
+ ],
352
+ "type": "object"
353
+ },
354
+ "CFSOption": {
355
+ "document": "描述CFS文件系统版本和挂载信息",
356
+ "members": [
357
+ {
358
+ "document": "文件系统本地挂载路径。",
359
+ "example": "/data/",
360
+ "member": "string",
361
+ "name": "LocalPath",
362
+ "required": true,
363
+ "type": "string",
364
+ "value_allowed_null": false
365
+ },
366
+ {
367
+ "document": "文件系统远程挂载ip及路径。",
368
+ "example": "172.0.0.1:/",
369
+ "member": "string",
370
+ "name": "RemotePath",
371
+ "required": true,
372
+ "type": "string",
373
+ "value_allowed_null": false
374
+ },
375
+ {
376
+ "document": "文件系统协议类型,默认值NFS 3.0。\n<li>NFS 3.0。\n<li>NFS 4.0。\n<li>TURBO。",
377
+ "example": "NFS 3.0",
378
+ "member": "string",
379
+ "name": "Protocol",
380
+ "required": false,
381
+ "type": "string",
382
+ "value_allowed_null": false
383
+ },
384
+ {
385
+ "document": "文件系统存储类型,默认值SD;其中 SD 为通用标准型标准型存储, HP为通用性能型存储, TB为turbo标准型, TP 为turbo性能型。",
386
+ "example": "SD",
387
+ "member": "string",
388
+ "name": "StorageType",
389
+ "required": false,
390
+ "type": "string",
391
+ "value_allowed_null": false
392
+ }
393
+ ],
394
+ "usage": "in"
395
+ },
396
+ "CFSOptionOverview": {
397
+ "document": "CFS存储选项概览信息。",
398
+ "members": [
399
+ {
400
+ "document": "文件系统本地挂载路径。",
401
+ "example": "/data/",
402
+ "member": "string",
403
+ "name": "LocalPath",
404
+ "required": true,
405
+ "type": "string",
406
+ "value_allowed_null": false
407
+ },
408
+ {
409
+ "document": "文件系统远程挂载ip及路径。",
410
+ "example": "172.0.0.1:/",
411
+ "member": "string",
412
+ "name": "RemotePath",
413
+ "required": true,
414
+ "type": "string",
415
+ "value_allowed_null": false
416
+ },
417
+ {
418
+ "document": "文件系统协议类型。\n<li>NFS 3.0。\n<li>NFS 4.0。\n<li>TURBO。",
419
+ "example": "NFS 3.0",
420
+ "member": "string",
421
+ "name": "Protocol",
422
+ "required": true,
423
+ "type": "string",
424
+ "value_allowed_null": false
425
+ },
426
+ {
427
+ "document": "文件系统存储类型,默认值SD;其中 SD 为通用标准型标准型存储, HP为通用性能型存储, TB为turbo标准型, TP 为turbo性能型。",
428
+ "example": "SD",
429
+ "member": "string",
430
+ "name": "StorageType",
431
+ "required": true,
432
+ "type": "string",
433
+ "value_allowed_null": false
434
+ }
435
+ ],
436
+ "usage": "out"
437
+ },
438
+ "ClusterActivity": {
439
+ "document": "符合条件的集群活动信息。",
440
+ "members": [
441
+ {
442
+ "document": "集群ID。",
443
+ "example": "无",
444
+ "member": "string",
445
+ "name": "ClusterId",
446
+ "required": true,
447
+ "type": "string",
448
+ "value_allowed_null": false
449
+ },
450
+ {
451
+ "document": "集群活动ID。",
452
+ "example": "无",
453
+ "member": "string",
454
+ "name": "ActivityId",
455
+ "required": true,
456
+ "type": "string",
457
+ "value_allowed_null": false
458
+ },
459
+ {
460
+ "document": "集群活动类型。取值范围:<br><li>CreateAndAddNodes:创建实例并添加进集群<br><li>RemoveNodesFromCluster:从集群移除实例<br><li>TerminateNodes:销毁实例<br><li>MountStorageOption:增加挂载选项并进行挂载<br><li>UmountStorageOption:删除集群挂载存储选项并解挂载\n",
461
+ "example": "无",
462
+ "member": "string",
463
+ "name": "ActivityType",
464
+ "required": true,
465
+ "type": "string",
466
+ "value_allowed_null": false
467
+ },
468
+ {
469
+ "document": "集群活动状态。取值范围:<br><li>PENDING:等待运行<br><li>RUNNING:运行中<br><li>SUCCESSFUL:活动成功<br><li>PARTIALLY_SUCCESSFUL:活动部分成功<br><li>FAILED:活动失败",
470
+ "example": "无",
471
+ "member": "string",
472
+ "name": "ActivityStatus",
473
+ "required": true,
474
+ "type": "string",
475
+ "value_allowed_null": false
476
+ },
477
+ {
478
+ "document": "集群活动状态码。\n注意:此字段可能返回 null,表示取不到有效值。",
479
+ "example": "无",
480
+ "member": "string",
481
+ "name": "ActivityStatusCode",
482
+ "required": true,
483
+ "type": "string",
484
+ "value_allowed_null": true
485
+ },
486
+ {
487
+ "document": "集群活动结果详情。\n注意:此字段可能返回 null,表示取不到有效值。",
488
+ "example": "无",
489
+ "member": "string",
490
+ "name": "ResultDetail",
491
+ "required": true,
492
+ "type": "string",
493
+ "value_allowed_null": true
494
+ },
495
+ {
496
+ "document": "集群活动起因。",
497
+ "example": "无",
498
+ "member": "string",
499
+ "name": "Cause",
500
+ "required": true,
501
+ "type": "string",
502
+ "value_allowed_null": false
503
+ },
504
+ {
505
+ "document": "集群活动描述。",
506
+ "example": "无",
507
+ "member": "string",
508
+ "name": "Description",
509
+ "required": true,
510
+ "type": "string",
511
+ "value_allowed_null": false
512
+ },
513
+ {
514
+ "document": "集群活动相关节点活动集合。",
515
+ "example": "无",
516
+ "member": "NodeActivity",
517
+ "name": "RelatedNodeActivitySet",
518
+ "required": true,
519
+ "type": "list",
520
+ "value_allowed_null": false
521
+ },
522
+ {
523
+ "document": "集群活动开始时间。\n注意:此字段可能返回 null,表示取不到有效值。",
524
+ "example": "无",
525
+ "member": "datetime_iso",
526
+ "name": "StartTime",
527
+ "required": true,
528
+ "type": "string",
529
+ "value_allowed_null": true
530
+ },
531
+ {
532
+ "document": "集群活动结束时间。\n注意:此字段可能返回 null,表示取不到有效值。",
533
+ "example": "无",
534
+ "member": "datetime_iso",
535
+ "name": "EndTime",
536
+ "required": true,
537
+ "type": "string",
538
+ "value_allowed_null": true
539
+ }
540
+ ],
541
+ "usage": "out"
542
+ },
543
+ "ClusterOverview": {
544
+ "document": "集群概览信息。",
545
+ "members": [
546
+ {
547
+ "document": "集群ID。",
548
+ "example": "hpc-2mv1i3d8",
549
+ "member": "string",
550
+ "name": "ClusterId",
551
+ "required": true,
552
+ "type": "string",
553
+ "value_allowed_null": false
554
+ },
555
+ {
556
+ "document": "集群状态。取值范围:<br><li>PENDING:创建中<br><li>INITING:初始化中<br><li>INIT_FAILED:初始化失败<br><li>RUNNING:运行中<br><li>TERMINATING:销毁中",
557
+ "example": "RUNNING",
558
+ "member": "string",
559
+ "name": "ClusterStatus",
560
+ "required": true,
561
+ "type": "string",
562
+ "value_allowed_null": false
563
+ },
564
+ {
565
+ "document": "集群名称。",
566
+ "example": "无",
567
+ "member": "string",
568
+ "name": "ClusterName",
569
+ "required": true,
570
+ "type": "string",
571
+ "value_allowed_null": false
572
+ },
573
+ {
574
+ "document": "集群位置信息。",
575
+ "example": "无",
576
+ "member": "Placement",
577
+ "name": "Placement",
578
+ "required": true,
579
+ "type": "object",
580
+ "value_allowed_null": false
581
+ },
582
+ {
583
+ "document": "集群创建时间。",
584
+ "example": "无",
585
+ "member": "datetime_iso",
586
+ "name": "CreateTime",
587
+ "required": true,
588
+ "type": "string",
589
+ "value_allowed_null": false
590
+ },
591
+ {
592
+ "document": "集群调度器。",
593
+ "example": "SGE",
594
+ "member": "string",
595
+ "name": "SchedulerType",
596
+ "required": true,
597
+ "type": "string",
598
+ "value_allowed_null": false
599
+ },
600
+ {
601
+ "document": "计算节点数量。",
602
+ "example": "1",
603
+ "member": "int64",
604
+ "name": "ComputeNodeCount",
605
+ "required": true,
606
+ "type": "int",
607
+ "value_allowed_null": false
608
+ },
609
+ {
610
+ "document": "计算节点概览。",
611
+ "example": "无",
612
+ "member": "ComputeNodeOverview",
613
+ "name": "ComputeNodeSet",
614
+ "required": true,
615
+ "type": "list",
616
+ "value_allowed_null": false
617
+ },
618
+ {
619
+ "document": "管控节点数量。",
620
+ "example": "1",
621
+ "member": "int64",
622
+ "name": "ManagerNodeCount",
623
+ "required": true,
624
+ "type": "int",
625
+ "value_allowed_null": false
626
+ },
627
+ {
628
+ "document": "管控节点概览。",
629
+ "example": "无",
630
+ "member": "ManagerNodeOverview",
631
+ "name": "ManagerNodeSet",
632
+ "required": true,
633
+ "type": "list",
634
+ "value_allowed_null": false
635
+ },
636
+ {
637
+ "document": "登录节点概览。",
638
+ "example": "无",
639
+ "member": "LoginNodeOverview",
640
+ "name": "LoginNodeSet",
641
+ "required": true,
642
+ "type": "list",
643
+ "value_allowed_null": false
644
+ },
645
+ {
646
+ "document": "登录节点数量。",
647
+ "example": "1",
648
+ "member": "int64",
649
+ "name": "LoginNodeCount",
650
+ "required": true,
651
+ "type": "int",
652
+ "value_allowed_null": false
653
+ },
654
+ {
655
+ "document": "集群所属私有网络ID。",
656
+ "example": "vpc-r9fr2jzy",
657
+ "member": "string",
658
+ "name": "VpcId",
659
+ "required": true,
660
+ "type": "string",
661
+ "value_allowed_null": false
662
+ }
663
+ ],
664
+ "usage": "out"
665
+ },
666
+ "ComputeNode": {
667
+ "document": "计算节点信息。",
668
+ "members": [
669
+ {
670
+ "document": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月<br><li>POSTPAID_BY_HOUR:按小时后付费<br><li>SPOTPAID:竞价付费<br>默认值:POSTPAID_BY_HOUR。",
671
+ "example": "POSTPAID_BY_HOUR",
672
+ "member": "string",
673
+ "name": "InstanceChargeType",
674
+ "required": false,
675
+ "type": "string",
676
+ "value_allowed_null": false
677
+ },
678
+ {
679
+ "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。",
680
+ "example": "无",
681
+ "member": "InstanceChargePrepaid",
682
+ "name": "InstanceChargePrepaid",
683
+ "required": false,
684
+ "type": "object",
685
+ "value_allowed_null": false
686
+ },
687
+ {
688
+ "document": "节点机型。不同实例机型指定了不同的资源规格。\n<br><li>具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。",
689
+ "example": "S2.SMALL2",
690
+ "member": "string",
691
+ "name": "InstanceType",
692
+ "required": false,
693
+ "type": "string",
694
+ "value_allowed_null": false
695
+ },
696
+ {
697
+ "document": "节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。",
698
+ "example": "无",
699
+ "member": "SystemDisk",
700
+ "name": "SystemDisk",
701
+ "required": false,
702
+ "type": "object",
703
+ "value_allowed_null": false
704
+ },
705
+ {
706
+ "document": "节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。",
707
+ "example": "无",
708
+ "member": "DataDisk",
709
+ "name": "DataDisks",
710
+ "required": false,
711
+ "type": "list",
712
+ "value_allowed_null": false
713
+ },
714
+ {
715
+ "document": "公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。",
716
+ "example": "无",
717
+ "member": "InternetAccessible",
718
+ "name": "InternetAccessible",
719
+ "required": false,
720
+ "type": "object",
721
+ "value_allowed_null": false
722
+ },
723
+ {
724
+ "document": "节点显示名称。<br><li>\n不指定节点显示名称则默认显示‘未命名’。\n最多支持60个字符。",
725
+ "example": "未命名",
726
+ "member": "string",
727
+ "name": "InstanceName",
728
+ "required": false,
729
+ "type": "string",
730
+ "value_allowed_null": false
731
+ }
732
+ ],
733
+ "usage": "in"
734
+ },
735
+ "ComputeNodeOverview": {
736
+ "document": "计算节点概览。",
737
+ "members": [
738
+ {
739
+ "document": "计算节点ID。\n注意:此字段可能返回 null,表示取不到有效值。",
740
+ "example": "ins-jfhc307q",
741
+ "member": "string",
742
+ "name": "NodeId",
743
+ "required": true,
744
+ "type": "string",
745
+ "value_allowed_null": true
746
+ }
747
+ ],
748
+ "usage": "out"
749
+ },
750
+ "CreateClusterRequest": {
751
+ "document": "CreateCluster请求参数结构体",
752
+ "members": [
753
+ {
754
+ "document": "集群中实例所在的位置。",
755
+ "example": "无",
756
+ "member": "Placement",
757
+ "name": "Placement",
758
+ "required": true,
759
+ "type": "object"
760
+ },
761
+ {
762
+ "document": "指定管理节点。",
763
+ "example": "无",
764
+ "member": "ManagerNode",
765
+ "name": "ManagerNode",
766
+ "required": false,
767
+ "type": "object"
768
+ },
769
+ {
770
+ "document": "指定管理节点的数量。默认取值:1。取值范围:1~2。",
771
+ "example": "无",
772
+ "member": "int64",
773
+ "name": "ManagerNodeCount",
774
+ "required": false,
775
+ "type": "int"
776
+ },
777
+ {
778
+ "document": "指定计算节点。",
779
+ "example": "无",
780
+ "member": "ComputeNode",
781
+ "name": "ComputeNode",
782
+ "required": false,
783
+ "type": "object"
784
+ },
785
+ {
786
+ "document": "指定计算节点的数量。默认取值:0。",
787
+ "example": "无",
788
+ "member": "int64",
789
+ "name": "ComputeNodeCount",
790
+ "required": false,
791
+ "type": "int"
792
+ },
793
+ {
794
+ "document": "调度器类型。默认取值:SLURM。<br><li>SGE:SGE调度器。<br><li>SLURM:SLURM调度器。",
795
+ "example": "SGE",
796
+ "member": "string",
797
+ "name": "SchedulerType",
798
+ "required": false,
799
+ "type": "string"
800
+ },
801
+ {
802
+ "document": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前支持部分公有镜像和自定义镜像。",
803
+ "example": "无",
804
+ "member": "string",
805
+ "name": "ImageId",
806
+ "required": false,
807
+ "type": "string"
808
+ },
809
+ {
810
+ "document": "私有网络相关信息配置。",
811
+ "example": "无",
812
+ "member": "VirtualPrivateCloud",
813
+ "name": "VirtualPrivateCloud",
814
+ "required": false,
815
+ "type": "object"
816
+ },
817
+ {
818
+ "document": "集群登录设置。",
819
+ "example": "无",
820
+ "member": "LoginSettings",
821
+ "name": "LoginSettings",
822
+ "required": false,
823
+ "type": "object"
824
+ },
825
+ {
826
+ "document": "集群中实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。",
827
+ "example": "无",
828
+ "member": "string",
829
+ "name": "SecurityGroupIds",
830
+ "required": false,
831
+ "type": "list"
832
+ },
833
+ {
834
+ "document": "用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。",
835
+ "example": "无",
836
+ "member": "string",
837
+ "name": "ClientToken",
838
+ "required": false,
839
+ "type": "string"
840
+ },
841
+ {
842
+ "document": "是否只预检此次请求。\ntrue:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。\n如果检查不通过,则返回对应错误码;\n如果检查通过,则返回RequestId.\nfalse(默认):发送正常请求,通过检查后直接创建实例",
843
+ "example": "无",
844
+ "member": "bool",
845
+ "name": "DryRun",
846
+ "required": false,
847
+ "type": "bool"
848
+ },
849
+ {
850
+ "document": "域名字服务类型。默认取值:NIS。\n<li>NIS:NIS域名字服务。",
851
+ "example": "NIS",
852
+ "member": "string",
853
+ "name": "AccountType",
854
+ "required": false,
855
+ "type": "string"
856
+ },
857
+ {
858
+ "document": "集群显示名称。",
859
+ "example": "无",
860
+ "member": "string",
861
+ "name": "ClusterName",
862
+ "required": false,
863
+ "type": "string"
864
+ },
865
+ {
866
+ "document": "集群存储选项",
867
+ "example": "无",
868
+ "member": "StorageOption",
869
+ "name": "StorageOption",
870
+ "required": false,
871
+ "type": "object"
872
+ },
873
+ {
874
+ "document": "指定登录节点。",
875
+ "example": "无",
876
+ "member": "LoginNode",
877
+ "name": "LoginNode",
878
+ "required": false,
879
+ "type": "object"
880
+ },
881
+ {
882
+ "document": "指定登录节点的数量。默认取值:0。取值范围:0~10。",
883
+ "example": "无",
884
+ "member": "int64",
885
+ "name": "LoginNodeCount",
886
+ "required": false,
887
+ "type": "int"
888
+ },
889
+ {
890
+ "document": "创建集群时同时绑定的标签对说明。",
891
+ "example": "无",
892
+ "member": "Tag",
893
+ "name": "Tags",
894
+ "required": false,
895
+ "type": "list"
896
+ },
897
+ {
898
+ "document": "弹性伸缩类型。默认值:THPC_AS<br><li>THPC_AS:集群自动扩缩容由THPC产品内部实现。<br><li>AS:集群自动扩缩容由[弹性伸缩](https://cloud.tencent.com/document/product/377/3154)产品实现。",
899
+ "example": "无",
900
+ "member": "string",
901
+ "name": "AutoScalingType",
902
+ "required": false,
903
+ "type": "string"
904
+ }
905
+ ],
906
+ "type": "object"
907
+ },
908
+ "CreateClusterResponse": {
909
+ "document": "CreateCluster返回参数结构体",
910
+ "members": [
911
+ {
912
+ "document": "集群ID。\n注意:此字段可能返回 null,表示取不到有效值。",
913
+ "example": "hpc-5lyv94lq",
914
+ "member": "string",
915
+ "name": "ClusterId",
916
+ "type": "string",
917
+ "value_allowed_null": true
918
+ },
919
+ {
920
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
921
+ "member": "string",
922
+ "name": "RequestId",
923
+ "type": "string"
924
+ }
925
+ ],
926
+ "type": "object"
927
+ },
928
+ "DataDisk": {
929
+ "document": "描述了数据盘的信息",
930
+ "members": [
931
+ {
932
+ "document": "数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,具体限制详见:[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0,表示不购买数据盘。更多限制详见产品文档。\n注意:此字段可能返回 null,表示取不到有效值。",
933
+ "example": "0",
934
+ "member": "int64",
935
+ "name": "DiskSize",
936
+ "required": true,
937
+ "type": "int",
938
+ "value_allowed_null": true
939
+ },
940
+ {
941
+ "document": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围:<br><li>LOCAL_NVME:本地NVME硬盘,与InstanceType强相关,不支持指定<br><li>LOCAL_PRO:本地HDD硬盘,与InstanceType强相关,不支持指定<br><li>CLOUD_BASIC:普通云硬盘<br><li>CLOUD_PREMIUM:高性能云硬盘<br><li>CLOUD_SSD:SSD云硬盘<br><li>CLOUD_HSSD:增强型SSD云硬盘<br><li>CLOUD_TSSD:极速型SSD云硬盘<br><li>CLOUD_BSSD:通用型SSD云硬盘\n注意:此字段可能返回 null,表示取不到有效值。",
942
+ "example": "CLOUD_BASIC",
943
+ "member": "string",
944
+ "name": "DiskType",
945
+ "required": false,
946
+ "type": "string",
947
+ "value_allowed_null": true
948
+ }
949
+ ],
950
+ "usage": "both"
951
+ },
952
+ "DeleteClusterRequest": {
953
+ "document": "DeleteCluster请求参数结构体",
954
+ "members": [
955
+ {
956
+ "document": "集群ID。",
957
+ "example": "hpc-5lyv94lq",
958
+ "member": "string",
959
+ "name": "ClusterId",
960
+ "required": true,
961
+ "type": "string"
962
+ }
963
+ ],
964
+ "type": "object"
965
+ },
966
+ "DeleteClusterResponse": {
967
+ "document": "DeleteCluster返回参数结构体",
968
+ "members": [
969
+ {
970
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
971
+ "member": "string",
972
+ "name": "RequestId",
973
+ "type": "string"
974
+ }
975
+ ],
976
+ "type": "object"
977
+ },
978
+ "DeleteClusterStorageOptionRequest": {
979
+ "document": "DeleteClusterStorageOption请求参数结构体",
980
+ "members": [
981
+ {
982
+ "document": "集群ID。",
983
+ "example": "hpc-5lyv94lq",
984
+ "member": "string",
985
+ "name": "ClusterId",
986
+ "required": true,
987
+ "type": "string"
988
+ },
989
+ {
990
+ "document": "本地挂载路径。",
991
+ "example": "/data/",
992
+ "member": "string",
993
+ "name": "LocalPath",
994
+ "required": true,
995
+ "type": "string"
996
+ }
997
+ ],
998
+ "type": "object"
999
+ },
1000
+ "DeleteClusterStorageOptionResponse": {
1001
+ "document": "DeleteClusterStorageOption返回参数结构体",
1002
+ "members": [
1003
+ {
1004
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1005
+ "member": "string",
1006
+ "name": "RequestId",
1007
+ "type": "string"
1008
+ }
1009
+ ],
1010
+ "type": "object"
1011
+ },
1012
+ "DeleteNodesRequest": {
1013
+ "document": "DeleteNodes请求参数结构体",
1014
+ "members": [
1015
+ {
1016
+ "document": "集群ID。",
1017
+ "example": "hpc-5lyv94lq",
1018
+ "member": "string",
1019
+ "name": "ClusterId",
1020
+ "required": true,
1021
+ "type": "string"
1022
+ },
1023
+ {
1024
+ "document": "节点ID。",
1025
+ "example": "无",
1026
+ "member": "string",
1027
+ "name": "NodeIds",
1028
+ "required": true,
1029
+ "type": "list"
1030
+ }
1031
+ ],
1032
+ "type": "object"
1033
+ },
1034
+ "DeleteNodesResponse": {
1035
+ "document": "DeleteNodes返回参数结构体",
1036
+ "members": [
1037
+ {
1038
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1039
+ "member": "string",
1040
+ "name": "RequestId",
1041
+ "type": "string"
1042
+ }
1043
+ ],
1044
+ "type": "object"
1045
+ },
1046
+ "DeleteQueueRequest": {
1047
+ "document": "DeleteQueue请求参数结构体",
1048
+ "members": [
1049
+ {
1050
+ "document": "集群ID。",
1051
+ "example": "hpc-prkxbd7c",
1052
+ "member": "string",
1053
+ "name": "ClusterId",
1054
+ "required": true,
1055
+ "type": "string"
1056
+ },
1057
+ {
1058
+ "document": "队列名称。<br><li>最多支持32个字符。",
1059
+ "example": "compute",
1060
+ "member": "string",
1061
+ "name": "QueueName",
1062
+ "required": true,
1063
+ "type": "string"
1064
+ }
1065
+ ],
1066
+ "type": "object"
1067
+ },
1068
+ "DeleteQueueResponse": {
1069
+ "document": "DeleteQueue返回参数结构体",
1070
+ "members": [
1071
+ {
1072
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1073
+ "member": "string",
1074
+ "name": "RequestId",
1075
+ "type": "string"
1076
+ }
1077
+ ],
1078
+ "type": "object"
1079
+ },
1080
+ "DescribeAutoScalingConfigurationRequest": {
1081
+ "document": "DescribeAutoScalingConfiguration请求参数结构体",
1082
+ "members": [
1083
+ {
1084
+ "document": "集群ID。\t",
1085
+ "example": "hpc-5lyv94lq",
1086
+ "member": "string",
1087
+ "name": "ClusterId",
1088
+ "required": true,
1089
+ "type": "string"
1090
+ }
1091
+ ],
1092
+ "type": "object"
1093
+ },
1094
+ "DescribeAutoScalingConfigurationResponse": {
1095
+ "document": "DescribeAutoScalingConfiguration返回参数结构体",
1096
+ "members": [
1097
+ {
1098
+ "document": "集群ID。",
1099
+ "example": "hpc-rv7hahw2",
1100
+ "member": "string",
1101
+ "name": "ClusterId",
1102
+ "type": "string",
1103
+ "value_allowed_null": false
1104
+ },
1105
+ {
1106
+ "document": "任务连续等待时间,队列的任务处于连续等待的时间。单位秒。",
1107
+ "example": "120",
1108
+ "member": "int64",
1109
+ "name": "ExpansionBusyTime",
1110
+ "type": "int",
1111
+ "value_allowed_null": false
1112
+ },
1113
+ {
1114
+ "document": "节点连续空闲(未运行作业)时间,一个节点连续处于空闲状态时间。",
1115
+ "example": "300",
1116
+ "member": "int64",
1117
+ "name": "ShrinkIdleTime",
1118
+ "type": "int",
1119
+ "value_allowed_null": false
1120
+ },
1121
+ {
1122
+ "document": "扩容队列配置概览列表。",
1123
+ "example": "无",
1124
+ "member": "QueueConfigOverview",
1125
+ "name": "QueueConfigs",
1126
+ "type": "list",
1127
+ "value_allowed_null": false
1128
+ },
1129
+ {
1130
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1131
+ "member": "string",
1132
+ "name": "RequestId",
1133
+ "type": "string"
1134
+ }
1135
+ ],
1136
+ "type": "object"
1137
+ },
1138
+ "DescribeClusterActivitiesRequest": {
1139
+ "document": "DescribeClusterActivities请求参数结构体",
1140
+ "members": [
1141
+ {
1142
+ "document": "集群ID。通过该参数指定需要查询活动历史记录的集群。",
1143
+ "example": "hpc-myd8fgsc",
1144
+ "member": "string",
1145
+ "name": "ClusterId",
1146
+ "required": true,
1147
+ "type": "string"
1148
+ },
1149
+ {
1150
+ "document": "偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
1151
+ "example": "0",
1152
+ "member": "int64",
1153
+ "name": "Offset",
1154
+ "required": false,
1155
+ "type": "int"
1156
+ },
1157
+ {
1158
+ "document": "返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
1159
+ "example": "20",
1160
+ "member": "int64",
1161
+ "name": "Limit",
1162
+ "required": false,
1163
+ "type": "int"
1164
+ }
1165
+ ],
1166
+ "type": "object"
1167
+ },
1168
+ "DescribeClusterActivitiesResponse": {
1169
+ "document": "DescribeClusterActivities返回参数结构体",
1170
+ "members": [
1171
+ {
1172
+ "document": "集群活动历史记录列表。",
1173
+ "example": "无",
1174
+ "member": "ClusterActivity",
1175
+ "name": "ClusterActivitySet",
1176
+ "type": "list",
1177
+ "value_allowed_null": false
1178
+ },
1179
+ {
1180
+ "document": "集群活动历史记录数量。",
1181
+ "example": "1",
1182
+ "member": "int64",
1183
+ "name": "TotalCount",
1184
+ "type": "int",
1185
+ "value_allowed_null": false
1186
+ },
1187
+ {
1188
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1189
+ "member": "string",
1190
+ "name": "RequestId",
1191
+ "type": "string"
1192
+ }
1193
+ ],
1194
+ "type": "object"
1195
+ },
1196
+ "DescribeClusterStorageOptionRequest": {
1197
+ "document": "DescribeClusterStorageOption请求参数结构体",
1198
+ "members": [
1199
+ {
1200
+ "document": "集群ID。",
1201
+ "example": "hpc-5lyv94lq",
1202
+ "member": "string",
1203
+ "name": "ClusterId",
1204
+ "required": true,
1205
+ "type": "string"
1206
+ }
1207
+ ],
1208
+ "type": "object"
1209
+ },
1210
+ "DescribeClusterStorageOptionResponse": {
1211
+ "document": "DescribeClusterStorageOption返回参数结构体",
1212
+ "members": [
1213
+ {
1214
+ "document": "集群存储选项信息概览。",
1215
+ "example": "无",
1216
+ "member": "StorageOptionOverview",
1217
+ "name": "StorageOption",
1218
+ "type": "object",
1219
+ "value_allowed_null": false
1220
+ },
1221
+ {
1222
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1223
+ "member": "string",
1224
+ "name": "RequestId",
1225
+ "type": "string"
1226
+ }
1227
+ ],
1228
+ "type": "object"
1229
+ },
1230
+ "DescribeClustersRequest": {
1231
+ "document": "DescribeClusters请求参数结构体",
1232
+ "members": [
1233
+ {
1234
+ "document": "集群ID列表。通过该参数可以指定需要查询信息的集群列表。<br>如果您不指定该参数,则返回Limit数量以内的集群信息。",
1235
+ "example": "无",
1236
+ "member": "string",
1237
+ "name": "ClusterIds",
1238
+ "required": false,
1239
+ "type": "list"
1240
+ },
1241
+ {
1242
+ "document": "偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
1243
+ "example": "0",
1244
+ "member": "int64",
1245
+ "name": "Offset",
1246
+ "required": false,
1247
+ "type": "int"
1248
+ },
1249
+ {
1250
+ "document": "返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
1251
+ "example": "20",
1252
+ "member": "int64",
1253
+ "name": "Limit",
1254
+ "required": false,
1255
+ "type": "int"
1256
+ }
1257
+ ],
1258
+ "type": "object"
1259
+ },
1260
+ "DescribeClustersResponse": {
1261
+ "document": "DescribeClusters返回参数结构体",
1262
+ "members": [
1263
+ {
1264
+ "document": "集群概览信息列表。",
1265
+ "example": "无",
1266
+ "member": "ClusterOverview",
1267
+ "name": "ClusterSet",
1268
+ "type": "list",
1269
+ "value_allowed_null": false
1270
+ },
1271
+ {
1272
+ "document": "集群数量。",
1273
+ "example": "1",
1274
+ "member": "int64",
1275
+ "name": "TotalCount",
1276
+ "type": "int",
1277
+ "value_allowed_null": false
1278
+ },
1279
+ {
1280
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1281
+ "member": "string",
1282
+ "name": "RequestId",
1283
+ "type": "string"
1284
+ }
1285
+ ],
1286
+ "type": "object"
1287
+ },
1288
+ "DescribeNodesRequest": {
1289
+ "document": "DescribeNodes请求参数结构体",
1290
+ "members": [
1291
+ {
1292
+ "document": "集群ID。",
1293
+ "example": "hpc-5lyv94lq",
1294
+ "member": "string",
1295
+ "name": "ClusterId",
1296
+ "required": true,
1297
+ "type": "string"
1298
+ },
1299
+ {
1300
+ "document": "<li><strong>queue-name</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>队列名称</strong>】进行过滤。队列名称形如:compute。</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\"><li><strong>node-role</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>节点角色</strong>】进行过滤。节点角色形如:Manager。(Manager:管控节点。Compute:计算节点。Login:登录节点。ManagerBackup:备用管控节点。)</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\"><li><strong>node-type</strong></li> <p style=\"padding-left: 30px;\">按照【<strong>节点类型</strong>】进行过滤。节点类型形如:STATIC。(STATIC:静态节点。DYNAMIC:弹性节点。)</p><p style=\"padding-left: 30px;\">类型:String</p><p style=\"padding-left: 30px;\">必选:否</p><p style=\"padding-left: 30px;\">每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。",
1301
+ "example": "无",
1302
+ "member": "Filter",
1303
+ "name": "Filters",
1304
+ "required": false,
1305
+ "type": "list"
1306
+ },
1307
+ {
1308
+ "document": "偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
1309
+ "example": "0",
1310
+ "member": "int64",
1311
+ "name": "Offset",
1312
+ "required": false,
1313
+ "type": "int"
1314
+ },
1315
+ {
1316
+ "document": "返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
1317
+ "example": "20",
1318
+ "member": "int64",
1319
+ "name": "Limit",
1320
+ "required": false,
1321
+ "type": "int"
1322
+ }
1323
+ ],
1324
+ "type": "object"
1325
+ },
1326
+ "DescribeNodesResponse": {
1327
+ "document": "DescribeNodes返回参数结构体",
1328
+ "members": [
1329
+ {
1330
+ "document": "节点概览信息列表。",
1331
+ "example": "无",
1332
+ "member": "NodeOverview",
1333
+ "name": "NodeSet",
1334
+ "type": "list",
1335
+ "value_allowed_null": false
1336
+ },
1337
+ {
1338
+ "document": "符合条件的节点数量。",
1339
+ "example": "1",
1340
+ "member": "int64",
1341
+ "name": "TotalCount",
1342
+ "type": "int",
1343
+ "value_allowed_null": false
1344
+ },
1345
+ {
1346
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1347
+ "member": "string",
1348
+ "name": "RequestId",
1349
+ "type": "string"
1350
+ }
1351
+ ],
1352
+ "type": "object"
1353
+ },
1354
+ "DescribeQueuesRequest": {
1355
+ "document": "DescribeQueues请求参数结构体",
1356
+ "members": [
1357
+ {
1358
+ "document": "集群ID。",
1359
+ "example": "hpc-5lyv94lq",
1360
+ "member": "string",
1361
+ "name": "ClusterId",
1362
+ "required": true,
1363
+ "type": "string"
1364
+ },
1365
+ {
1366
+ "document": "偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
1367
+ "example": "0",
1368
+ "member": "int64",
1369
+ "name": "Offset",
1370
+ "required": false,
1371
+ "type": "int"
1372
+ },
1373
+ {
1374
+ "document": "返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。",
1375
+ "example": "20",
1376
+ "member": "int64",
1377
+ "name": "Limit",
1378
+ "required": false,
1379
+ "type": "int"
1380
+ }
1381
+ ],
1382
+ "type": "object"
1383
+ },
1384
+ "DescribeQueuesResponse": {
1385
+ "document": "DescribeQueues返回参数结构体",
1386
+ "members": [
1387
+ {
1388
+ "document": "队列概览信息列表。",
1389
+ "example": "无",
1390
+ "member": "QueueOverview",
1391
+ "name": "QueueSet",
1392
+ "type": "list",
1393
+ "value_allowed_null": false
1394
+ },
1395
+ {
1396
+ "document": "符合条件的节点数量。",
1397
+ "example": "1",
1398
+ "member": "int64",
1399
+ "name": "TotalCount",
1400
+ "type": "int",
1401
+ "value_allowed_null": false
1402
+ },
1403
+ {
1404
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
1405
+ "member": "string",
1406
+ "name": "RequestId",
1407
+ "type": "string"
1408
+ }
1409
+ ],
1410
+ "type": "object"
1411
+ },
1412
+ "ExpansionNodeConfig": {
1413
+ "document": "弹性扩容节点配置信息。",
1414
+ "members": [
1415
+ {
1416
+ "document": "扩容实例所在的位置。",
1417
+ "example": "无",
1418
+ "member": "Placement",
1419
+ "name": "Placement",
1420
+ "required": true,
1421
+ "type": "object",
1422
+ "value_allowed_null": false
1423
+ },
1424
+ {
1425
+ "document": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月<br><li>POSTPAID_BY_HOUR:按小时后付费<br><li>SPOTPAID:竞价付费<br>默认值:POSTPAID_BY_HOUR。",
1426
+ "example": "POSTPAID_BY_HOUR",
1427
+ "member": "string",
1428
+ "name": "InstanceChargeType",
1429
+ "required": false,
1430
+ "type": "string",
1431
+ "value_allowed_null": false
1432
+ },
1433
+ {
1434
+ "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。",
1435
+ "example": "无",
1436
+ "member": "InstanceChargePrepaid",
1437
+ "name": "InstanceChargePrepaid",
1438
+ "required": false,
1439
+ "type": "object",
1440
+ "value_allowed_null": false
1441
+ },
1442
+ {
1443
+ "document": "节点机型。不同实例机型指定了不同的资源规格。\n<br><li>具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。",
1444
+ "example": "S2.SMALL2",
1445
+ "member": "string",
1446
+ "name": "InstanceType",
1447
+ "required": false,
1448
+ "type": "string",
1449
+ "value_allowed_null": false
1450
+ },
1451
+ {
1452
+ "document": "私有网络相关信息配置。",
1453
+ "example": "无",
1454
+ "member": "VirtualPrivateCloud",
1455
+ "name": "VirtualPrivateCloud",
1456
+ "required": false,
1457
+ "type": "object",
1458
+ "value_allowed_null": false
1459
+ }
1460
+ ],
1461
+ "usage": "in"
1462
+ },
1463
+ "ExpansionNodeConfigOverview": {
1464
+ "document": "扩容节点配置信息概览。",
1465
+ "members": [
1466
+ {
1467
+ "document": "节点机型。\n注意:此字段可能返回 null,表示取不到有效值。",
1468
+ "example": "S2.SMALL2",
1469
+ "member": "string",
1470
+ "name": "InstanceType",
1471
+ "required": false,
1472
+ "type": "string",
1473
+ "value_allowed_null": true
1474
+ },
1475
+ {
1476
+ "document": "扩容实例所在的位置。\n注意:此字段可能返回 null,表示取不到有效值。",
1477
+ "example": "无",
1478
+ "member": "Placement",
1479
+ "name": "Placement",
1480
+ "required": false,
1481
+ "type": "object",
1482
+ "value_allowed_null": true
1483
+ },
1484
+ {
1485
+ "document": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。\n注意:此字段可能返回 null,表示取不到有效值。",
1486
+ "example": "POSTPAID_BY_HOUR",
1487
+ "member": "string",
1488
+ "name": "InstanceChargeType",
1489
+ "required": false,
1490
+ "type": "string",
1491
+ "value_allowed_null": true
1492
+ },
1493
+ {
1494
+ "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。\n注意:此字段可能返回 null,表示取不到有效值。",
1495
+ "example": "无",
1496
+ "member": "InstanceChargePrepaid",
1497
+ "name": "InstanceChargePrepaid",
1498
+ "required": false,
1499
+ "type": "object",
1500
+ "value_allowed_null": true
1501
+ },
1502
+ {
1503
+ "document": "私有网络相关信息配置。\n注意:此字段可能返回 null,表示取不到有效值。",
1504
+ "example": "无",
1505
+ "member": "VirtualPrivateCloud",
1506
+ "name": "VirtualPrivateCloud",
1507
+ "required": false,
1508
+ "type": "object",
1509
+ "value_allowed_null": true
1510
+ },
1511
+ {
1512
+ "document": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。\n注意:此字段可能返回 null,表示取不到有效值。",
1513
+ "example": "img-3la7wgnt",
1514
+ "member": "string",
1515
+ "name": "ImageId",
1516
+ "required": false,
1517
+ "type": "string",
1518
+ "value_allowed_null": true
1519
+ },
1520
+ {
1521
+ "document": "公网带宽相关信息设置。\n注意:此字段可能返回 null,表示取不到有效值。",
1522
+ "example": "无",
1523
+ "member": "InternetAccessible",
1524
+ "name": "InternetAccessible",
1525
+ "required": false,
1526
+ "type": "object",
1527
+ "value_allowed_null": true
1528
+ },
1529
+ {
1530
+ "document": "节点系统盘配置信息。\n注意:此字段可能返回 null,表示取不到有效值。",
1531
+ "example": "无",
1532
+ "member": "SystemDisk",
1533
+ "name": "SystemDisk",
1534
+ "required": false,
1535
+ "type": "object",
1536
+ "value_allowed_null": true
1537
+ },
1538
+ {
1539
+ "document": "节点数据盘配置信息。\n注意:此字段可能返回 null,表示取不到有效值。",
1540
+ "example": "无",
1541
+ "member": "DataDisk",
1542
+ "name": "DataDisks",
1543
+ "required": false,
1544
+ "type": "list",
1545
+ "value_allowed_null": true
1546
+ }
1547
+ ],
1548
+ "usage": "out"
1549
+ },
1550
+ "Filter": {
1551
+ "document": ">描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等\n> * 若存在多个`Filter`时,`Filter`间的关系为逻辑与(`AND`)关系。\n> * 若同一个`Filter`存在多个`Values`,同一`Filter`下`Values`间的关系为逻辑或(`OR`)关系。",
1552
+ "members": [
1553
+ {
1554
+ "document": "需要过滤的字段。",
1555
+ "example": "无",
1556
+ "member": "string",
1557
+ "name": "Name",
1558
+ "required": true,
1559
+ "type": "string",
1560
+ "value_allowed_null": true
1561
+ },
1562
+ {
1563
+ "document": "字段的过滤值。",
1564
+ "example": "无",
1565
+ "member": "string",
1566
+ "name": "Values",
1567
+ "required": true,
1568
+ "type": "list",
1569
+ "value_allowed_null": true
1570
+ }
1571
+ ],
1572
+ "usage": "in"
1573
+ },
1574
+ "GooseFSOption": {
1575
+ "document": "描述GooseFS挂载信息",
1576
+ "members": [
1577
+ {
1578
+ "document": "文件系统本地挂载路径。",
1579
+ "example": "/data",
1580
+ "member": "string",
1581
+ "name": "LocalPath",
1582
+ "required": true,
1583
+ "type": "string",
1584
+ "value_allowed_null": false
1585
+ },
1586
+ {
1587
+ "document": "文件系统远程挂载路径。",
1588
+ "example": "/data/goosefs-fuse",
1589
+ "member": "string",
1590
+ "name": "RemotePath",
1591
+ "required": true,
1592
+ "type": "string",
1593
+ "value_allowed_null": false
1594
+ },
1595
+ {
1596
+ "document": "文件系统master的ip和端口。",
1597
+ "example": "无",
1598
+ "member": "string",
1599
+ "name": "Masters",
1600
+ "required": true,
1601
+ "type": "list",
1602
+ "value_allowed_null": false
1603
+ }
1604
+ ],
1605
+ "usage": "in"
1606
+ },
1607
+ "GooseFSOptionOverview": {
1608
+ "document": "GooseFS存储选项概览信息。",
1609
+ "members": [
1610
+ {
1611
+ "document": "文件系统本地挂载路径。",
1612
+ "example": "/data/",
1613
+ "member": "string",
1614
+ "name": "LocalPath",
1615
+ "required": true,
1616
+ "type": "string",
1617
+ "value_allowed_null": false
1618
+ },
1619
+ {
1620
+ "document": "文件系统远程挂载路径。",
1621
+ "example": "/data/goosefs-fuse/",
1622
+ "member": "string",
1623
+ "name": "RemotePath",
1624
+ "required": true,
1625
+ "type": "string",
1626
+ "value_allowed_null": false
1627
+ },
1628
+ {
1629
+ "document": "文件系统master的ip和端口。",
1630
+ "example": "无",
1631
+ "member": "string",
1632
+ "name": "Masters",
1633
+ "required": true,
1634
+ "type": "list",
1635
+ "value_allowed_null": false
1636
+ }
1637
+ ],
1638
+ "usage": "out"
1639
+ },
1640
+ "GooseFSxOption": {
1641
+ "document": "描述GooseFSx挂载信息",
1642
+ "members": [
1643
+ {
1644
+ "document": "文件系统master的ip和端口列表。",
1645
+ "example": "[\"172.16.0.2:55533\",\"172.16.0.3:55533\",\"172.16.0.4:55533\"]",
1646
+ "member": "string",
1647
+ "name": "Masters",
1648
+ "required": true,
1649
+ "type": "list",
1650
+ "value_allowed_null": true
1651
+ },
1652
+ {
1653
+ "document": "文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。",
1654
+ "example": "/goosefsx/x_c60_54oi5id3_proxy/",
1655
+ "member": "string",
1656
+ "name": "LocalPath",
1657
+ "required": true,
1658
+ "type": "string",
1659
+ "value_allowed_null": true
1660
+ }
1661
+ ],
1662
+ "usage": "in"
1663
+ },
1664
+ "GooseFSxOptionOverview": {
1665
+ "document": "GooseFSx存储选项概览信息。",
1666
+ "members": [
1667
+ {
1668
+ "document": "文件系统master的ip和端口列表。\n注意:此字段可能返回 null,表示取不到有效值。",
1669
+ "example": "[\"172.16.0.2:55533\",\"172.16.0.3:55533\",\"172.16.0.4:55533\"]",
1670
+ "member": "string",
1671
+ "name": "Masters",
1672
+ "required": false,
1673
+ "type": "list",
1674
+ "value_allowed_null": true
1675
+ },
1676
+ {
1677
+ "document": "文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。\n注意:此字段可能返回 null,表示取不到有效值。",
1678
+ "example": "/goosefsx/x_c60_54oi5id3_proxy/",
1679
+ "member": "string",
1680
+ "name": "LocalPath",
1681
+ "required": false,
1682
+ "type": "string",
1683
+ "value_allowed_null": true
1684
+ }
1685
+ ],
1686
+ "usage": "out"
1687
+ },
1688
+ "InstanceChargePrepaid": {
1689
+ "document": "描述了实例的计费模式",
1690
+ "members": [
1691
+ {
1692
+ "document": "购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。\n注意:此字段可能返回 null,表示取不到有效值。",
1693
+ "example": "1",
1694
+ "member": "int64",
1695
+ "name": "Period",
1696
+ "required": true,
1697
+ "type": "int",
1698
+ "value_allowed_null": true
1699
+ },
1700
+ {
1701
+ "document": "自动续费标识。取值范围:\nNOTIFY_AND_AUTO_RENEW:通知过期且自动续费\nNOTIFY_AND_MANUAL_RENEW:通知过期不自动续费\nDISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费\n\n默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。\n注意:此字段可能返回 null,表示取不到有效值。",
1702
+ "example": "NOTIFY_AND_AUTO_RENEW",
1703
+ "member": "string",
1704
+ "name": "RenewFlag",
1705
+ "required": false,
1706
+ "type": "string",
1707
+ "value_allowed_null": true
1708
+ }
1709
+ ],
1710
+ "usage": "both"
1711
+ },
1712
+ "InternetAccessible": {
1713
+ "document": "描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等",
1714
+ "members": [
1715
+ {
1716
+ "document": "网络计费类型。取值范围:\nBANDWIDTH_PREPAID:预付费按带宽结算\nTRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费\nBANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费\nBANDWIDTH_PACKAGE:带宽包用户\n默认取值:非带宽包用户默认与子机付费类型保持一致。\n注意:此字段可能返回 null,表示取不到有效值。",
1717
+ "example": "TRAFFIC_POSTPAID_BY_HOUR",
1718
+ "member": "string",
1719
+ "name": "InternetChargeType",
1720
+ "required": false,
1721
+ "type": "string",
1722
+ "value_allowed_null": true
1723
+ },
1724
+ {
1725
+ "document": "公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽。\n注意:此字段可能返回 null,表示取不到有效值。",
1726
+ "example": "0",
1727
+ "member": "int64",
1728
+ "name": "InternetMaxBandwidthOut",
1729
+ "required": false,
1730
+ "type": "int",
1731
+ "value_allowed_null": true
1732
+ }
1733
+ ],
1734
+ "usage": "both"
1735
+ },
1736
+ "LoginNode": {
1737
+ "document": "登录节点信息。",
1738
+ "members": [
1739
+ {
1740
+ "document": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月<br><li>POSTPAID_BY_HOUR:按小时后付费<br>默认值:POSTPAID_BY_HOUR。",
1741
+ "example": "POSTPAID_BY_HOUR",
1742
+ "member": "string",
1743
+ "name": "InstanceChargeType",
1744
+ "required": false,
1745
+ "type": "string",
1746
+ "value_allowed_null": false
1747
+ },
1748
+ {
1749
+ "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。",
1750
+ "example": "无",
1751
+ "member": "InstanceChargePrepaid",
1752
+ "name": "InstanceChargePrepaid",
1753
+ "required": false,
1754
+ "type": "object",
1755
+ "value_allowed_null": false
1756
+ },
1757
+ {
1758
+ "document": "节点机型。不同实例机型指定了不同的资源规格。\n<br><li>具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。",
1759
+ "example": "S2.SMALL2",
1760
+ "member": "string",
1761
+ "name": "InstanceType",
1762
+ "required": false,
1763
+ "type": "string",
1764
+ "value_allowed_null": false
1765
+ },
1766
+ {
1767
+ "document": "节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。",
1768
+ "example": "无",
1769
+ "member": "SystemDisk",
1770
+ "name": "SystemDisk",
1771
+ "required": false,
1772
+ "type": "object",
1773
+ "value_allowed_null": false
1774
+ },
1775
+ {
1776
+ "document": "节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。",
1777
+ "example": "无",
1778
+ "member": "DataDisk",
1779
+ "name": "DataDisks",
1780
+ "required": false,
1781
+ "type": "list",
1782
+ "value_allowed_null": false
1783
+ },
1784
+ {
1785
+ "document": "公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。",
1786
+ "example": "无",
1787
+ "member": "InternetAccessible",
1788
+ "name": "InternetAccessible",
1789
+ "required": false,
1790
+ "type": "object",
1791
+ "value_allowed_null": false
1792
+ },
1793
+ {
1794
+ "document": "节点显示名称。<br><li>\n不指定节点显示名称则默认显示‘未命名’。\n最多支持60个字符。",
1795
+ "example": "未命名",
1796
+ "member": "string",
1797
+ "name": "InstanceName",
1798
+ "required": false,
1799
+ "type": "string",
1800
+ "value_allowed_null": false
1801
+ }
1802
+ ],
1803
+ "usage": "in"
1804
+ },
1805
+ "LoginNodeOverview": {
1806
+ "document": "登录节点概览。",
1807
+ "members": [
1808
+ {
1809
+ "document": "登录节点ID。",
1810
+ "example": "ins-jfhc307q",
1811
+ "member": "string",
1812
+ "name": "NodeId",
1813
+ "required": true,
1814
+ "type": "string",
1815
+ "value_allowed_null": false
1816
+ }
1817
+ ],
1818
+ "usage": "out"
1819
+ },
1820
+ "LoginSettings": {
1821
+ "document": "描述了实例登录相关配置与信息。",
1822
+ "members": [
1823
+ {
1824
+ "document": "实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:<br><li>Linux实例密码必须8到30位,至少包括两项[a-z],[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。<br><li>Windows实例密码必须12到30位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) \\` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。<br><br>若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。",
1825
+ "example": "无",
1826
+ "member": "string",
1827
+ "name": "Password",
1828
+ "required": false,
1829
+ "type": "string",
1830
+ "value_allowed_null": false
1831
+ }
1832
+ ],
1833
+ "usage": "in"
1834
+ },
1835
+ "ManagerNode": {
1836
+ "document": "管控节点信息",
1837
+ "members": [
1838
+ {
1839
+ "document": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月<br><li>POSTPAID_BY_HOUR:按小时后付费<br>默认值:POSTPAID_BY_HOUR。",
1840
+ "example": "POSTPAID_BY_HOUR",
1841
+ "member": "string",
1842
+ "name": "InstanceChargeType",
1843
+ "required": false,
1844
+ "type": "string",
1845
+ "value_allowed_null": false
1846
+ },
1847
+ {
1848
+ "document": "预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。",
1849
+ "example": "无",
1850
+ "member": "InstanceChargePrepaid",
1851
+ "name": "InstanceChargePrepaid",
1852
+ "required": false,
1853
+ "type": "object",
1854
+ "value_allowed_null": false
1855
+ },
1856
+ {
1857
+ "document": "节点机型。不同实例机型指定了不同的资源规格。\n<br><li>对于付费模式为PREPAID或POSTPAID\\_BY\\_HOUR的实例创建,具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。",
1858
+ "example": "S2.SMALL2",
1859
+ "member": "string",
1860
+ "name": "InstanceType",
1861
+ "required": false,
1862
+ "type": "string",
1863
+ "value_allowed_null": false
1864
+ },
1865
+ {
1866
+ "document": "节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。",
1867
+ "example": "无",
1868
+ "member": "SystemDisk",
1869
+ "name": "SystemDisk",
1870
+ "required": false,
1871
+ "type": "object",
1872
+ "value_allowed_null": false
1873
+ },
1874
+ {
1875
+ "document": "节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。",
1876
+ "example": "无",
1877
+ "member": "DataDisk",
1878
+ "name": "DataDisks",
1879
+ "required": false,
1880
+ "type": "list",
1881
+ "value_allowed_null": false
1882
+ },
1883
+ {
1884
+ "document": "公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。",
1885
+ "example": "无",
1886
+ "member": "InternetAccessible",
1887
+ "name": "InternetAccessible",
1888
+ "required": false,
1889
+ "type": "object",
1890
+ "value_allowed_null": false
1891
+ },
1892
+ {
1893
+ "document": "节点显示名称。<br><li>\n不指定节点显示名称则默认显示‘未命名’。\n</li><li>购买多个节点,如果指定模式串`{R:x}`,表示生成数字[`[x, x+n-1]`,其中`n`表示购买节点的数量,例如`server_{R:3}`,购买1个时,节点显示名称为`server_3`;购买2个时,节点显示名称分别为`server_3`,`server_4`。支持指定多个模式串`{R:x}`。\n购买多个节点,如果不指定模式串,则在节点显示名称添加后缀`1、2...n`,其中`n`表示购买节点的数量,例如`server_`,购买2个时,节点显示名称分别为`server_1`,`server_2`。</li><li>\n最多支持60个字符(包含模式串)。",
1894
+ "example": "未命名",
1895
+ "member": "string",
1896
+ "name": "InstanceName",
1897
+ "required": false,
1898
+ "type": "string",
1899
+ "value_allowed_null": false
1900
+ }
1901
+ ],
1902
+ "usage": "in"
1903
+ },
1904
+ "ManagerNodeOverview": {
1905
+ "document": "管控节点概览。",
1906
+ "members": [
1907
+ {
1908
+ "document": "管控节点ID。\n注意:此字段可能返回 null,表示取不到有效值。",
1909
+ "example": "ins-jfhc307q",
1910
+ "member": "string",
1911
+ "name": "NodeId",
1912
+ "required": true,
1913
+ "type": "string",
1914
+ "value_allowed_null": true
1915
+ }
1916
+ ],
1917
+ "usage": "out"
1918
+ },
1919
+ "NodeActivity": {
1920
+ "document": "节点活动信息。",
1921
+ "members": [
1922
+ {
1923
+ "document": "节点活动所在的实例ID。\n注意:此字段可能返回 null,表示取不到有效值。",
1924
+ "example": "无",
1925
+ "member": "string",
1926
+ "name": "NodeInstanceId",
1927
+ "required": true,
1928
+ "type": "string",
1929
+ "value_allowed_null": true
1930
+ },
1931
+ {
1932
+ "document": "节点活动状态。取值范围:<br><li>RUNNING:运行中<br><li>SUCCESSFUL:活动成功<br><li>FAILED:活动失败",
1933
+ "example": "无",
1934
+ "member": "string",
1935
+ "name": "NodeActivityStatus",
1936
+ "required": true,
1937
+ "type": "string",
1938
+ "value_allowed_null": false
1939
+ },
1940
+ {
1941
+ "document": "节点活动状态码。\n注意:此字段可能返回 null,表示取不到有效值。",
1942
+ "example": "无",
1943
+ "member": "string",
1944
+ "name": "NodeActivityStatusCode",
1945
+ "required": true,
1946
+ "type": "string",
1947
+ "value_allowed_null": true
1948
+ },
1949
+ {
1950
+ "document": "节点活动状态原因。\n注意:此字段可能返回 null,表示取不到有效值。",
1951
+ "example": "无",
1952
+ "member": "string",
1953
+ "name": "NodeActivityStatusReason",
1954
+ "required": true,
1955
+ "type": "string",
1956
+ "value_allowed_null": true
1957
+ }
1958
+ ],
1959
+ "usage": "out"
1960
+ },
1961
+ "NodeOverview": {
1962
+ "document": "节点概览信息。",
1963
+ "members": [
1964
+ {
1965
+ "document": "节点实例ID。\n注意:此字段可能返回 null,表示取不到有效值。",
1966
+ "example": "ins-f5ew7k5w",
1967
+ "member": "string",
1968
+ "name": "InstanceId",
1969
+ "required": false,
1970
+ "type": "string",
1971
+ "value_allowed_null": true
1972
+ },
1973
+ {
1974
+ "document": "节点所在可用区信息。\n注意:此字段可能返回 null,表示取不到有效值。",
1975
+ "example": "ap-chongqing-1",
1976
+ "member": "string",
1977
+ "name": "Zone",
1978
+ "required": false,
1979
+ "type": "string",
1980
+ "value_allowed_null": true
1981
+ },
1982
+ {
1983
+ "document": "节点状态。<br><li>SUBMITTED:已完成提交。<br><li>CREATING:创建中。<br><li>CREATED:完成创建。<br><li>INITING:初始化中。<br><li>INIT_FAILED:初始化失败。<br><li>RUNNING:运行中。<br><li>DELETING:销毁中。\n注意:此字段可能返回 null,表示取不到有效值。",
1984
+ "example": "RUNNING",
1985
+ "member": "string",
1986
+ "name": "NodeState",
1987
+ "required": false,
1988
+ "type": "string",
1989
+ "value_allowed_null": true
1990
+ },
1991
+ {
1992
+ "document": "镜像ID。\n注意:此字段可能返回 null,表示取不到有效值。",
1993
+ "example": "img-l8og963d",
1994
+ "member": "string",
1995
+ "name": "ImageId",
1996
+ "required": false,
1997
+ "type": "string",
1998
+ "value_allowed_null": true
1999
+ },
2000
+ {
2001
+ "document": "节点所属队列名称。\n注意:此字段可能返回 null,表示取不到有效值。",
2002
+ "example": "compute",
2003
+ "member": "string",
2004
+ "name": "QueueName",
2005
+ "required": false,
2006
+ "type": "string",
2007
+ "value_allowed_null": true
2008
+ },
2009
+ {
2010
+ "document": "节点角色。<br><li>Manager:管控节点。<br><li>Compute:计算节点。<br><li>Login:登录节点。<br><li>ManagerBackup:备用管控节点。\n注意:此字段可能返回 null,表示取不到有效值。",
2011
+ "example": "Compute",
2012
+ "member": "string",
2013
+ "name": "NodeRole",
2014
+ "required": false,
2015
+ "type": "string",
2016
+ "value_allowed_null": true
2017
+ },
2018
+ {
2019
+ "document": "节点类型。<br><li>STATIC:静态节点。<br><li>DYNAMIC:弹性节点。\n注意:此字段可能返回 null,表示取不到有效值。",
2020
+ "example": "STATIC",
2021
+ "member": "string",
2022
+ "name": "NodeType",
2023
+ "required": false,
2024
+ "type": "string",
2025
+ "value_allowed_null": true
2026
+ }
2027
+ ],
2028
+ "usage": "out"
2029
+ },
2030
+ "Placement": {
2031
+ "document": "描述了实例的抽象位置",
2032
+ "members": [
2033
+ {
2034
+ "document": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。\n注意:此字段可能返回 null,表示取不到有效值。",
2035
+ "example": "无",
2036
+ "member": "string",
2037
+ "name": "Zone",
2038
+ "required": true,
2039
+ "type": "string",
2040
+ "value_allowed_null": true
2041
+ }
2042
+ ],
2043
+ "usage": "both"
2044
+ },
2045
+ "QueueConfig": {
2046
+ "document": "扩容队列配置。",
2047
+ "members": [
2048
+ {
2049
+ "document": "队列名称。",
2050
+ "example": "compute",
2051
+ "member": "string",
2052
+ "name": "QueueName",
2053
+ "required": true,
2054
+ "type": "string",
2055
+ "value_allowed_null": false
2056
+ },
2057
+ {
2058
+ "document": "队列中弹性节点数量最小值。取值范围0~200。",
2059
+ "example": "0",
2060
+ "member": "uint64",
2061
+ "name": "MinSize",
2062
+ "required": false,
2063
+ "type": "int",
2064
+ "value_allowed_null": false
2065
+ },
2066
+ {
2067
+ "document": "队列中弹性节点数量最大值。取值范围0~200。",
2068
+ "example": "10",
2069
+ "member": "uint64",
2070
+ "name": "MaxSize",
2071
+ "required": false,
2072
+ "type": "int",
2073
+ "value_allowed_null": false
2074
+ },
2075
+ {
2076
+ "document": "是否开启自动扩容。",
2077
+ "example": "无",
2078
+ "member": "bool",
2079
+ "name": "EnableAutoExpansion",
2080
+ "required": false,
2081
+ "type": "bool",
2082
+ "value_allowed_null": false
2083
+ },
2084
+ {
2085
+ "document": "是否开启自动缩容。",
2086
+ "example": "无",
2087
+ "member": "bool",
2088
+ "name": "EnableAutoShrink",
2089
+ "required": false,
2090
+ "type": "bool",
2091
+ "value_allowed_null": false
2092
+ },
2093
+ {
2094
+ "document": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜和特定自定义镜像。",
2095
+ "example": "ins-jfhc307q",
2096
+ "member": "string",
2097
+ "name": "ImageId",
2098
+ "required": false,
2099
+ "type": "string",
2100
+ "value_allowed_null": false
2101
+ },
2102
+ {
2103
+ "document": "节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。",
2104
+ "example": "无",
2105
+ "member": "SystemDisk",
2106
+ "name": "SystemDisk",
2107
+ "required": false,
2108
+ "type": "object",
2109
+ "value_allowed_null": false
2110
+ },
2111
+ {
2112
+ "document": "节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。",
2113
+ "example": "无",
2114
+ "member": "DataDisk",
2115
+ "name": "DataDisks",
2116
+ "required": false,
2117
+ "type": "list",
2118
+ "value_allowed_null": false
2119
+ },
2120
+ {
2121
+ "document": "公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。",
2122
+ "example": "无",
2123
+ "member": "InternetAccessible",
2124
+ "name": "InternetAccessible",
2125
+ "required": false,
2126
+ "type": "object",
2127
+ "value_allowed_null": false
2128
+ },
2129
+ {
2130
+ "document": "扩容节点配置信息。",
2131
+ "example": "无",
2132
+ "member": "ExpansionNodeConfig",
2133
+ "name": "ExpansionNodeConfigs",
2134
+ "required": false,
2135
+ "type": "list",
2136
+ "value_allowed_null": false
2137
+ }
2138
+ ],
2139
+ "usage": "in"
2140
+ },
2141
+ "QueueConfigOverview": {
2142
+ "document": "扩容队列配置概览。",
2143
+ "members": [
2144
+ {
2145
+ "document": "队列名称。",
2146
+ "example": "compute",
2147
+ "member": "string",
2148
+ "name": "QueueName",
2149
+ "required": false,
2150
+ "type": "string",
2151
+ "value_allowed_null": false
2152
+ },
2153
+ {
2154
+ "document": "队列中弹性节点数量最小值。取值范围0~200。",
2155
+ "example": "1",
2156
+ "member": "int64",
2157
+ "name": "MinSize",
2158
+ "required": false,
2159
+ "type": "int",
2160
+ "value_allowed_null": false
2161
+ },
2162
+ {
2163
+ "document": "队列中弹性节点数量最大值。取值范围0~200。",
2164
+ "example": "5",
2165
+ "member": "int64",
2166
+ "name": "MaxSize",
2167
+ "required": false,
2168
+ "type": "int",
2169
+ "value_allowed_null": false
2170
+ },
2171
+ {
2172
+ "document": "是否开启自动扩容。",
2173
+ "example": "无",
2174
+ "member": "bool",
2175
+ "name": "EnableAutoExpansion",
2176
+ "required": false,
2177
+ "type": "bool",
2178
+ "value_allowed_null": false
2179
+ },
2180
+ {
2181
+ "document": "是否开启自动缩容。",
2182
+ "example": "无",
2183
+ "member": "bool",
2184
+ "name": "EnableAutoShrink",
2185
+ "required": false,
2186
+ "type": "bool",
2187
+ "value_allowed_null": false
2188
+ },
2189
+ {
2190
+ "document": "扩容节点配置信息。",
2191
+ "example": "无",
2192
+ "member": "ExpansionNodeConfigOverview",
2193
+ "name": "ExpansionNodeConfigs",
2194
+ "required": false,
2195
+ "type": "list",
2196
+ "value_allowed_null": false
2197
+ }
2198
+ ],
2199
+ "usage": "out"
2200
+ },
2201
+ "QueueOverview": {
2202
+ "document": "队列信息概览。",
2203
+ "members": [
2204
+ {
2205
+ "document": "队列名称。\n注意:此字段可能返回 null,表示取不到有效值。",
2206
+ "example": "compute",
2207
+ "member": "string",
2208
+ "name": "QueueName",
2209
+ "required": false,
2210
+ "type": "string",
2211
+ "value_allowed_null": true
2212
+ }
2213
+ ],
2214
+ "usage": "out"
2215
+ },
2216
+ "SetAutoScalingConfigurationRequest": {
2217
+ "document": "SetAutoScalingConfiguration请求参数结构体",
2218
+ "members": [
2219
+ {
2220
+ "document": "集群ID。",
2221
+ "example": "hpc-5lyv94lq",
2222
+ "member": "string",
2223
+ "name": "ClusterId",
2224
+ "required": true,
2225
+ "type": "string"
2226
+ },
2227
+ {
2228
+ "document": "任务连续等待时间,队列的任务处于连续等待的时间。单位秒。默认值120。",
2229
+ "example": "120",
2230
+ "member": "int64",
2231
+ "name": "ExpansionBusyTime",
2232
+ "required": false,
2233
+ "type": "int"
2234
+ },
2235
+ {
2236
+ "document": "节点连续空闲(未运行作业)时间,一个节点连续处于空闲状态时间。单位秒。默认值300。",
2237
+ "example": "300",
2238
+ "member": "int64",
2239
+ "name": "ShrinkIdleTime",
2240
+ "required": false,
2241
+ "type": "int"
2242
+ },
2243
+ {
2244
+ "document": "扩容队列配置列表。",
2245
+ "example": "无",
2246
+ "member": "QueueConfig",
2247
+ "name": "QueueConfigs",
2248
+ "required": false,
2249
+ "type": "list"
2250
+ },
2251
+ {
2252
+ "document": "是否只预检此次请求。\ntrue:发送检查请求,不会绑定弹性伸缩组。检查项包括是否填写了必需参数,请求格式,业务限制。\n如果检查不通过,则返回对应错误码;\n如果检查通过,则返回RequestId。\nfalse(默认):发送正常请求,通过检查后直接绑定弹性伸缩组。",
2253
+ "example": "无",
2254
+ "member": "bool",
2255
+ "name": "DryRun",
2256
+ "required": false,
2257
+ "type": "bool"
2258
+ }
2259
+ ],
2260
+ "type": "object"
2261
+ },
2262
+ "SetAutoScalingConfigurationResponse": {
2263
+ "document": "SetAutoScalingConfiguration返回参数结构体",
2264
+ "members": [
2265
+ {
2266
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
2267
+ "member": "string",
2268
+ "name": "RequestId",
2269
+ "type": "string"
2270
+ }
2271
+ ],
2272
+ "type": "object"
2273
+ },
2274
+ "StorageOption": {
2275
+ "document": "描述集群文件系统选项",
2276
+ "members": [
2277
+ {
2278
+ "document": "集群挂载CFS文件系统选项。",
2279
+ "example": "无",
2280
+ "member": "CFSOption",
2281
+ "name": "CFSOptions",
2282
+ "required": false,
2283
+ "type": "list",
2284
+ "value_allowed_null": false
2285
+ },
2286
+ {
2287
+ "document": "集群挂载GooseFS文件系统选项。",
2288
+ "example": "无",
2289
+ "member": "GooseFSOption",
2290
+ "name": "GooseFSOptions",
2291
+ "required": false,
2292
+ "type": "list",
2293
+ "value_allowed_null": false
2294
+ },
2295
+ {
2296
+ "document": "集群挂载GooseFSx文件系统选项。",
2297
+ "example": "无",
2298
+ "member": "GooseFSxOption",
2299
+ "name": "GooseFSxOptions",
2300
+ "required": false,
2301
+ "type": "list",
2302
+ "value_allowed_null": true
2303
+ }
2304
+ ],
2305
+ "usage": "in"
2306
+ },
2307
+ "StorageOptionOverview": {
2308
+ "document": "集群存储选项概览信息。",
2309
+ "members": [
2310
+ {
2311
+ "document": "CFS存储选项概览信息列表。",
2312
+ "example": "无",
2313
+ "member": "CFSOptionOverview",
2314
+ "name": "CFSOptions",
2315
+ "required": true,
2316
+ "type": "list",
2317
+ "value_allowed_null": false
2318
+ },
2319
+ {
2320
+ "document": "GooseFS存储选项概览信息列表。",
2321
+ "example": "无",
2322
+ "member": "GooseFSOptionOverview",
2323
+ "name": "GooseFSOptions",
2324
+ "required": true,
2325
+ "type": "list",
2326
+ "value_allowed_null": false
2327
+ },
2328
+ {
2329
+ "document": "GooseFSx存储选项概览信息列表。",
2330
+ "example": "无",
2331
+ "member": "GooseFSxOptionOverview",
2332
+ "name": "GooseFSxOptions",
2333
+ "required": false,
2334
+ "type": "list",
2335
+ "value_allowed_null": false
2336
+ }
2337
+ ],
2338
+ "usage": "out"
2339
+ },
2340
+ "SystemDisk": {
2341
+ "document": "描述了操作系统所在块设备即系统盘的信息",
2342
+ "members": [
2343
+ {
2344
+ "document": "系统盘类型。系统盘类型限制详见存储概述。取值范围:\nCLOUD_BASIC:普通云硬盘\nCLOUD_SSD:SSD云硬盘\nCLOUD_PREMIUM:高性能云硬盘\n\n默认取值:当前有库存的硬盘类型。\n注意:此字段可能返回 null,表示取不到有效值。",
2345
+ "example": "CLOUD_BASIC",
2346
+ "member": "string",
2347
+ "name": "DiskType",
2348
+ "required": false,
2349
+ "type": "string",
2350
+ "value_allowed_null": true
2351
+ },
2352
+ {
2353
+ "document": "系统盘大小,单位:GB。默认值为 50\n注意:此字段可能返回 null,表示取不到有效值。",
2354
+ "example": "50",
2355
+ "member": "int64",
2356
+ "name": "DiskSize",
2357
+ "required": false,
2358
+ "type": "int",
2359
+ "value_allowed_null": true
2360
+ }
2361
+ ],
2362
+ "usage": "both"
2363
+ },
2364
+ "Tag": {
2365
+ "document": "标签键值对。",
2366
+ "members": [
2367
+ {
2368
+ "document": "标签键",
2369
+ "example": "无",
2370
+ "member": "string",
2371
+ "name": "Key",
2372
+ "required": true,
2373
+ "type": "string",
2374
+ "value_allowed_null": false
2375
+ },
2376
+ {
2377
+ "document": "标签值",
2378
+ "example": "无",
2379
+ "member": "string",
2380
+ "name": "Value",
2381
+ "required": true,
2382
+ "type": "string",
2383
+ "value_allowed_null": false
2384
+ }
2385
+ ],
2386
+ "usage": "in"
2387
+ },
2388
+ "VirtualPrivateCloud": {
2389
+ "document": "描述了VPC相关信息",
2390
+ "members": [
2391
+ {
2392
+ "document": "私有网络ID,形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询;也可以调用接口 [DescribeVpcEx](/document/api/215/1372) ,从接口返回中的`unVpcId`字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`,则强制使用默认vpc网络。\n注意:此字段可能返回 null,表示取不到有效值。",
2393
+ "example": "无",
2394
+ "member": "string",
2395
+ "name": "VpcId",
2396
+ "required": true,
2397
+ "type": "string",
2398
+ "value_allowed_null": true
2399
+ },
2400
+ {
2401
+ "document": "私有网络子网ID,形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询;也可以调用接口 [DescribeSubnets](/document/api/215/15784) ,从接口返回中的`unSubnetId`字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`,则强制使用默认vpc网络。\n注意:此字段可能返回 null,表示取不到有效值。",
2402
+ "example": "无",
2403
+ "member": "string",
2404
+ "name": "SubnetId",
2405
+ "required": true,
2406
+ "type": "string",
2407
+ "value_allowed_null": true
2408
+ }
2409
+ ],
2410
+ "usage": "both"
2411
+ }
2412
+ },
2413
+ "version": "1.0"
2414
+ }