-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbatch.d.ts
1603 lines (1475 loc) · 70.3 KB
/
batch.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 计算环境的创建或销毁活动 */
declare interface Activity {
/** 活动ID */
ActivityId?: string;
/** 计算节点ID */
ComputeNodeId?: string;
/** 计算节点活动类型，创建或者销毁 */
ComputeNodeActivityType?: string;
/** 计算环境ID */
EnvId?: string;
/** 起因 */
Cause?: string;
/** 活动状态 */
ActivityState?: string;
/** 状态原因 */
StateReason?: string;
/** 活动开始时间 */
StartTime?: string;
/** 活动结束时间 */
EndTime?: string | null;
/** 云服务器实例ID */
InstanceId?: string | null;
}
/** agent运行模式 */
declare interface AgentRunningMode {
/** 场景类型，支持WINDOWS */
Scene: string | null;
/** 运行Agent的User */
User: string | null;
/** 运行Agent的Session */
Session: string | null;
}
/** 计算环境 */
declare interface AnonymousComputeEnv {
/** 计算环境管理类型 */
EnvType?: string;
/** 计算环境具体参数 */
EnvData?: EnvData;
/** 数据盘挂载选项 */
MountDataDisks?: MountDataDisk[];
/** agent运行模式，适用于Windows系统 */
AgentRunningMode?: AgentRunningMode;
}
/** 应用程序信息 */
declare interface Application {
/** 应用程序的交付方式，包括PACKAGE、LOCAL 两种取值，分别指远程存储的软件包、计算环境本地。 */
DeliveryForm: string | null;
/** 任务执行命令。与Commands不能同时指定。 */
Command?: string | null;
/** 应用程序软件包的远程存储路径 */
PackagePath?: string | null;
/** 应用使用Docker的相关配置。在使用Docker配置的情况下，DeliveryForm 为 LOCAL 表示直接使用Docker镜像内部的应用软件，通过Docker方式运行；DeliveryForm 为 PACKAGE，表示将远程应用包注入到Docker镜像后，通过Docker方式运行。为避免Docker不同版本的兼容性问题，Docker安装包及相关依赖由Batch统一负责，对于已安装Docker的自定义镜像，请卸载后再使用Docker特性。 */
Docker?: Docker | null;
/** 任务执行命令信息。与Command不能同时指定。 */
Commands?: CommandLine[] | null;
}
/** 授权认证信息 */
declare interface Authentication {
/** 授权场景，例如COS */
Scene: string | null;
/** SecretId */
SecretId: string | null;
/** SecretKey */
SecretKey: string | null;
}
/** 任务执行信息描述。 */
declare interface CommandLine {
/** 任务执行命令。 */
Command: string | null;
}
/** 计算环境创建信息。 */
declare interface ComputeEnvCreateInfo {
/** 计算环境 ID */
EnvId?: string;
/** 计算环境名称 */
EnvName?: string | null;
/** 计算环境描述 */
EnvDescription?: string | null;
/** 计算环境类型，仅支持“MANAGED”类型 */
EnvType?: string;
/** 计算环境参数 */
EnvData?: EnvData;
/** 数据盘挂载选项 */
MountDataDisks?: MountDataDisk[] | null;
/** 输入映射 */
InputMappings?: InputMapping[] | null;
/** 授权信息 */
Authentications?: Authentication[] | null;
/** 通知信息 */
Notifications?: Notification[] | null;
/** 计算节点期望个数 */
DesiredComputeNodeCount?: number;
/** 计算环境标签列表 */
Tags?: Tag[] | null;
}
/** 计算环境属性数据 */
declare interface ComputeEnvData {
/** CVM实例类型列表 */
InstanceTypes: string[];
}
/** 计算环境信息 */
declare interface ComputeEnvView {
/** 计算环境ID */
EnvId?: string;
/** 计算环境名称 */
EnvName?: string;
/** 位置信息 */
Placement?: Placement;
/** 创建时间 */
CreateTime?: string;
/** 计算节点统计指标 */
ComputeNodeMetrics?: ComputeNodeMetrics;
/** 计算环境类型 */
EnvType?: string;
/** 计算节点期望个数 */
DesiredComputeNodeCount?: number;
/** 计算环境资源类型，当前为CVM和CPM（黑石） */
ResourceType?: string;
/** 下一步动作 */
NextAction?: string;
/** 用户添加到计算环境中的计算节点个数 */
AttachedComputeNodeCount?: number;
/** 计算环境绑定的标签列表。 */
Tags?: Tag[] | null;
}
/** 计算节点 */
declare interface ComputeNode {
/** 计算节点ID */
ComputeNodeId?: string;
/** 计算节点实例ID，对于CVM场景，即为CVM的InstanceId */
ComputeNodeInstanceId?: string;
/** 计算节点状态 */
ComputeNodeState?: string;
/** CPU核数 */
Cpu?: number;
/** 内存容量，单位GiB */
Mem?: number;
/** 资源创建完成时间 */
ResourceCreatedTime?: string;
/** 计算节点运行 TaskInstance 可用容量。0表示计算节点忙碌。 */
TaskInstanceNumAvailable?: number;
/** Batch Agent 版本 */
AgentVersion?: string;
/** 实例内网IP */
PrivateIpAddresses?: string[];
/** 实例公网IP */
PublicIpAddresses?: string[];
/** 计算环境资源类型，当前为CVM和CPM（黑石） */
ResourceType?: string;
/** 计算环境资源来源。BATCH_CREATED：由批量计算创建的实例资源。USER_ATTACHED：用户添加到计算环境中的实例资源。 */
ResourceOrigin?: string;
}
/** 计算节点统计指标 */
declare interface ComputeNodeMetrics {
/** 已经完成提交的计算节点数量 */
SubmittedCount?: number;
/** 创建中的计算节点数量 */
CreatingCount?: number;
/** 创建失败的计算节点数量 */
CreationFailedCount?: number;
/** 完成创建的计算节点数量 */
CreatedCount?: number;
/** 运行中的计算节点数量 */
RunningCount?: number;
/** 销毁中的计算节点数量 */
DeletingCount?: number;
/** 异常的计算节点数量 */
AbnormalCount?: number;
}
/** 黑石私有网络 */
declare interface CpmVirtualPrivateCloud {
/** 黑石私有网络ID */
VpcId: string;
/** 黑石子网ID */
SubnetId: string;
}
/** 描述了数据盘的信息 */
declare interface DataDisk {
/** 数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。 */
DiskSize: number;
/** 数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD：通用型SSD云硬盘默认取值：LOCAL_BASIC。该参数对`ResizeInstanceDisk`接口无效。 */
DiskType?: string;
/** 数据盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID，暂时不支持该参数。该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。 */
DiskId?: string;
/** 数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘 false：子机销毁时，保留数据盘 默认取值：true 该参数目前仅用于 `RunInstances` 接口。 */
DeleteWithInstance?: boolean | null;
/** 数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。 */
SnapshotId?: string | null;
/** 数据盘是加密。取值范围：true：加密 false：不加密 默认取值：false 该参数目前仅用于 `RunInstances` 接口。 */
Encrypt?: boolean | null;
/** 自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。该参数目前仅用于 `RunInstances` 接口。 */
KmsKeyId?: string | null;
/** 云硬盘性能，单位：MB/s */
ThroughputPerformance?: number | null;
/** 所属的独享集群ID。 */
CdcId?: string | null;
/** 突发性能 注：内测中。 */
BurstPerformance?: boolean | null;
/** 磁盘名称，长度不超过128 个字符。该参数正在邀测中，暂未开放使用。 */
DiskName?: string;
}
/** 依赖关系 */
declare interface Dependence {
/** 依赖关系的起点任务名称 */
StartTask: string | null;
/** 依赖关系的终点任务名称 */
EndTask: string | null;
}
/** Docker容器信息 */
declare interface Docker {
/** Docker Hub填写“[user/repo]:[tag]”，Tencent Registry填写“ccr.ccs.tencentyun.com/[namespace/repo]:[tag]” */
Image: string;
/** Docker Hub 用户名或 Tencent Registry 用户名；公共镜像可不填写此参数。 */
User?: string;
/** Docker Hub 密码或 Tencent Registry 密码；公共镜像可不填写此参数。 */
Password?: string;
/** Docker Hub 可以不填，但确保具有公网访问能力。或者是 Tencent Registry 服务地址“ccr.ccs.tencentyun.com” */
Server?: string;
/** 拉取Docker镜像重试次数。默认值：0。 */
MaxRetryCount?: number;
/** 拉取Docker镜像失败时延迟时间。单位：秒。 */
DelayOnRetry?: number;
/** Docker命令运行参数。 */
DockerRunOption?: string | null;
}
/** 描述了实例的增强服务启用情况与其设置，如云安全，云监控等实例 Agent */
declare interface EnhancedService {
/** 开启云安全服务。若不指定该参数，则默认开启云安全服务。 */
SecurityService?: RunSecurityServiceEnabled;
/** 开启云监控服务。若不指定该参数，则默认开启云监控服务。 */
MonitorService?: RunMonitorServiceEnabled;
/** 开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。 */
AutomationService?: RunAutomationServiceEnabled;
}
/** 计算环境数据 */
declare interface EnvData {
/** CVM实例类型，不能与InstanceTypes和InstanceTypeOptions同时出现。 */
InstanceType?: string;
/** CVM镜像ID */
ImageId?: string;
/** 实例系统盘配置信息 */
SystemDisk?: SystemDisk;
/** 实例数据盘配置信息 */
DataDisks?: DataDisk[];
/** 私有网络相关信息配置，与Zones和VirtualPrivateClouds不能同时指定。 */
VirtualPrivateCloud?: VirtualPrivateCloud;
/** 公网带宽相关信息设置 */
InternetAccessible?: InternetAccessible;
/** CVM实例显示名称 */
InstanceName?: string;
/** 实例登录设置 */
LoginSettings?: LoginSettings;
/** 实例所属安全组 */
SecurityGroupIds?: string[];
/** 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。 */
EnhancedService?: EnhancedService;
/** CVM实例计费类型POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。 */
InstanceChargeType?: string;
/** 实例的市场相关选项，如竞价实例相关参数 */
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/** CVM实例类型列表，不能与InstanceType和InstanceTypeOptions同时出现。指定该字段后，计算节点按照机型先后顺序依次尝试创建，直到实例创建成功，结束遍历过程。最多支持10个机型。 */
InstanceTypes?: string[];
/** CVM实例机型配置。不能与InstanceType和InstanceTypes同时出现。 */
InstanceTypeOptions?: InstanceTypeOptions;
/** 可用区列表，支持跨可用区创建CVM实例。与VirtualPrivateCloud和VirtualPrivateClouds不能同时指定。 */
Zones?: string[];
/** 私有网络列表，支持跨私有网络创建CVM实例。与VirtualPrivateCloud和Zones不能同时指定。 */
VirtualPrivateClouds?: VirtualPrivateCloud[];
}
/** 黑石计算环境数据 */
declare interface EnvDataCpm {
/** 黑石可用区名称列表。如ap-guangzhou-bls-1, 可通过黑石接口[DescribeRegions]( https://cloud.tencent.com/document/api/386/33564)接口获取。不是Batch可用区名称。目前仅支持一个可用区名称。 */
Zones: string[];
/** 购买的机型ID。通过黑石接口[DescribeDeviceClass]( https://cloud.tencent.com/document/api/386/32911)查询设备型号，获取机型信息。 */
InstanceTypes: string[];
/** 购买时长单位，取值：m(月)。 */
TimeUnit: string;
/** 购买时长。 */
TimeSpan: number;
/** RAID类型ID。通过黑石接口[DescribeDeviceClassPartition]( https://cloud.tencent.com/document/api/386/32910)查询机型RAID方式以及系统盘大小，获取RAID信息。 */
RaidId: number;
/** 部署服务器的操作系统ID。通过批量计算接口DescribeCpmOsInfo查询操作系统信息。 */
OsTypeId: number;
/** 黑石VPC列表，目前仅支持一个VPC。 */
VirtualPrivateClouds: CpmVirtualPrivateCloud[];
/** 是否安装安全Agent，取值：1(安装) 0(不安装)，默认取值0。 */
NeedSecurityAgent?: number;
/** 是否安装监控Agent，取值：1(安装) 0(不安装)，默认取值0。 */
NeedMonitorAgent?: number;
/** 自动续费标志位，取值：1(自动续费) 0(不自动续费)，默认取值0。 */
AutoRenewFlag?: number;
/** 数据盘是否格式化，取值：1(格式化) 0(不格式化)，默认取值为1。 */
IsZoning?: number;
/** 指定数据盘的文件系统格式，当前支持 ext4和xfs选项， 默认为ext4。 参数适用于数据盘和Linux， 且在IsZoning为1时生效。 */
FileSystem?: string;
/** 设置Linux root或Windows Administrator的密码。若不设置此参数，默认情况下会随机生成密码，并以站内信方式通知到用户。 */
Password?: string;
/** 是否分配弹性公网IP，取值：1(分配) 0(不分配)，默认取值0。 */
ApplyEip?: number;
/** 弹性公网IP计费模式，取值：flow(按流量计费) bandwidth(按带宽计费)，默认取值flow。 */
EipPayMode?: string;
/** 弹性公网IP带宽限制，单位Mb。 */
EipBandwidth?: number;
/** 自定义镜像ID，取值生效时用自定义镜像部署物理机。 */
ImageId?: string;
/** 系统盘根分区大小，单位为G，默认取值10G。通过黑石接口[DescribeDeviceClassPartition]( https://cloud.tencent.com/document/api/386/32910)查询机型RAID方式以及系统盘大小，获取根分区信息。 */
SysRootSpace?: number;
/** /data分区大小，单位为G。如果系统盘还有剩余大小，会分配给/data分区。（特殊情况：如果剩余空间不足10G，并且没有指定/data分区，则剩余空间会分配给Root分区）。 */
SysDataSpace?: number;
/** 是否开启超线程，取值：1(开启) 0(关闭)，默认取值1。 */
HyperThreading?: number;
/** 指定的内网IP列表，不指定时自动分配。 */
LanIps?: string[];
}
/** 环境变量 */
declare interface EnvVar {
/** 环境变量名称 */
Name: string | null;
/** 环境变量取值 */
Value: string | null;
}
/** 事件配置 */
declare interface EventConfig {
/** 事件类型，包括：“JOB_RUNNING”：作业运行，适用于"SubmitJob"。“JOB_SUCCEED”：作业成功，适用于"SubmitJob"。“JOB_FAILED”：作业失败，适用于"SubmitJob"。“JOB_FAILED_INTERRUPTED”：作业失败，保留实例，适用于"SubmitJob"。“TASK_RUNNING”：任务运行，适用于"SubmitJob"。“TASK_SUCCEED”：任务成功，适用于"SubmitJob"。“TASK_FAILED”：任务失败，适用于"SubmitJob"。“TASK_FAILED_INTERRUPTED”：任务失败，保留实例，适用于"SubmitJob"。“TASK_INSTANCE_RUNNING”：任务实例运行，适用于"SubmitJob"。“TASK_INSTANCE_SUCCEED”：任务实例成功，适用于"SubmitJob"。“TASK_INSTANCE_FAILED”：任务实例失败，适用于"SubmitJob"。“TASK_INSTANCE_FAILED_INTERRUPTED”：任务实例失败，保留实例，适用于"SubmitJob"。“COMPUTE_ENV_CREATED”：计算环境已创建，适用于"CreateComputeEnv"。“COMPUTE_ENV_DELETED”：计算环境已删除，适用于"CreateComputeEnv"。“COMPUTE_NODE_CREATED”：计算节点已创建，适用于"CreateComputeEnv"和"SubmitJob"。“COMPUTE_NODE_CREATION_FAILED”：计算节点创建失败，适用于"CreateComputeEnv"和"SubmitJob"。“COMPUTE_NODE_RUNNING”：计算节点运行中，适用于"CreateComputeEnv"和"SubmitJob"。“COMPUTE_NODE_ABNORMAL”：计算节点异常，适用于"CreateComputeEnv"和"SubmitJob"。“COMPUTE_NODE_DELETING”：计算节点已删除，适用于"CreateComputeEnv"和"SubmitJob"。 */
EventName: string;
/** 自定义键值对 */
EventVars: EventVar[];
}
/** 自定义键值对 */
declare interface EventVar {
/** 自定义键 */
Name: string | null;
/** 自定义值 */
Value: string | null;
}
/** 扩展数据 */
declare interface Externals {
/** 释放地址 */
ReleaseAddress?: boolean | null;
/** 不支持的网络类型，取值范围：BASIC：基础网络VPC1.0：私有网络VPC1.0 */
UnsupportNetworks?: string[] | null;
/** HDD本地存储属性 */
StorageBlockAttr?: StorageBlock | null;
}
/** >描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等> * 若存在多个`Filter`时，`Filter`间的关系为逻辑与（`AND`）关系。> * 若同一个`Filter`存在多个`Values`，同一`Filter`下`Values`间的关系为逻辑或（`OR`）关系。>> 以[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口的`Filter`为例。若我们需要查询可用区（`zone`）为广州一区 ***并且*** 实例计费模式（`instance-charge-type`）为包年包月 ***或者*** 按量计费的实例时，可如下实现：```Filters.0.Name=zone&Filters.0.Values.0=ap-guangzhou-1&Filters.1.Name=instance-charge-type&Filters.1.Values.0=PREPAID&Filters.1.Values.1=POSTPAID_BY_HOUR``` */
declare interface Filter {
/** 需要过滤的字段。 */
Name: string;
/** 字段的过滤值。 */
Values: string[];
}
/** 输入映射 */
declare interface InputMapping {
/** 源端路径 */
SourcePath: string | null;
/** 目的端路径 */
DestinationPath: string | null;
/** 挂载配置项参数 */
MountOptionParameter?: string | null;
}
/** 描述实例的信息 */
declare interface Instance {
/** 实例ID */
InstanceId: string;
/** 镜像ID */
ImageId?: string;
/** 实例登录设置。 */
LoginSettings?: LoginSettings;
}
/** 实例分类列表 */
declare interface InstanceCategoryItem {
/** 实例类型名 */
InstanceCategory?: string;
/** 实例族列表 */
InstanceFamilySet?: string[];
}
/** 批量计算可用的InstanceTypeConfig信息 */
declare interface InstanceTypeConfig {
/** 内存容量，单位：`GB`。 */
Mem?: number;
/** CPU核数，单位：核。 */
Cpu?: number;
/** 实例机型。 */
InstanceType?: string;
/** 可用区。 */
Zone?: string;
/** 实例机型系列。 */
InstanceFamily?: string;
}
/** 实例机型配置。 */
declare interface InstanceTypeOptions {
/** CPU核数。 */
CPU: number;
/** 内存值，单位GB。 */
Memory: number;
/** 实例机型类别，可选参数：“ALL”、“GENERAL”、“GENERAL_2”、“GENERAL_3”、“COMPUTE”、“COMPUTE_2”和“COMPUTE_3”。默认值“ALL”。 */
InstanceCategories?: string[];
}
/** 描述实例机型配额信息。 */
declare interface InstanceTypeQuotaItem {
/** 可用区。 */
Zone?: string;
/** 实例机型。 */
InstanceType?: string;
/** 实例计费模式。取值范围： PREPAID：表示预付费，即包年包月POSTPAID_BY_HOUR：表示后付费，即按量计费CDHPAID：表示[专用宿主机](https://cloud.tencent.com/document/product/416)付费，即只对`专用宿主机`计费，不对`专用宿主机`上的实例计费。`SPOTPAID`：表示竞价实例付费。 */
InstanceChargeType?: string;
/** 网卡类型，例如：25代表25G网卡 */
NetworkCard?: number;
/** 扩展属性。 */
Externals?: Externals | null;
/** 实例的CPU核数，单位：核。 */
Cpu?: number;
/** 实例内存容量，单位：`GB`。 */
Memory?: number;
/** 实例机型系列。 */
InstanceFamily?: string;
/** 机型名称。 */
TypeName?: string;
/** 本地磁盘规格列表。当该参数返回为空值时，表示当前情况下无法创建本地盘。 */
LocalDiskTypeList?: LocalDiskType[];
/** 实例是否售卖。取值范围： SELL：表示实例可购买SOLD_OUT：表示实例已售罄。 */
Status?: string;
/** 实例的售卖价格。 */
Price?: ItemPrice;
/** 售罄原因。 */
SoldOutReason?: string | null;
/** 内网带宽，单位Gbps。 */
InstanceBandwidth?: number;
/** 网络收发包能力，单位万PPS。 */
InstancePps?: number;
/** 本地存储块数量。 */
StorageBlockAmount?: number;
/** 处理器型号。 */
CpuType?: string;
/** 实例的GPU数量。 */
Gpu?: number;
/** 实例的FPGA数量。 */
Fpga?: number;
/** 实例备注信息。 */
Remark?: string;
/** 实例机型映射的物理GPU卡数，单位：卡。vGPU卡型小于1，直通卡型大于等于1。vGPU是通过分片虚拟化技术，将物理GPU卡重新划分，同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。 */
GpuCount?: number;
/** 实例的CPU主频信息 */
Frequency?: string;
/** 描述库存情况。取值范围： EnoughStock：表示对应库存非常充足 NormalStock：表示对应库存供应有保障 UnderStock：表示对应库存即将售罄 WithoutStock：表示对应库存已经售罄 */
StatusCategory?: string | null;
}
/** 描述了实例的公网可访问性，声明了实例的公网使用计费模式，最大带宽等 */
declare interface InternetAccessible {
/** 网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。 */
InternetChargeType?: string;
/** 公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。 */
InternetMaxBandwidthOut?: number;
/** 是否分配公网IP。取值范围：true：表示分配公网IPfalse：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。 */
PublicIpAssigned?: boolean;
/** 带宽包ID。可通过[`DescribeBandwidthPackages`](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。 */
BandwidthPackageId?: string;
}
/** 描述了单项的价格信息 */
declare interface ItemPrice {
/** 后续合计费用的原价，后付费模式使用，单位：元。如返回了其他时间区间项，如UnitPriceSecondStep，则本项代表时间区间在(0, 96)小时；若未返回其他时间区间项，则本项代表全时段，即(0, ∞)小时 */
UnitPrice?: number | null;
/** 后续计价单元，后付费模式使用，可取值范围： HOUR：表示计价单元是按每小时来计算。当前涉及该计价单元的场景有：实例按小时后付费（POSTPAID_BY_HOUR）、带宽按小时后付费（BANDWIDTH_POSTPAID_BY_HOUR）：GB：表示计价单元是按每GB来计算。当前涉及该计价单元的场景有：流量按小时后付费（TRAFFIC_POSTPAID_BY_HOUR）。 */
ChargeUnit?: string | null;
/** 预支合计费用的原价，预付费模式使用，单位：元。 */
OriginalPrice?: number | null;
/** 预支合计费用的折扣价，预付费模式使用，单位：元。 */
DiscountPrice?: number | null;
/** 折扣，如20.0代表2折。 */
Discount?: number | null;
/** 后续合计费用的折扣价，后付费模式使用，单位：元如返回了其他时间区间项，如UnitPriceDiscountSecondStep，则本项代表时间区间在(0, 96)小时；若未返回其他时间区间项，则本项代表全时段，即(0, ∞)小时 */
UnitPriceDiscount?: number | null;
/** 使用时间区间在(96, 360)小时的后续合计费用的原价，后付费模式使用，单位：元。 */
UnitPriceSecondStep?: number | null;
/** 使用时间区间在(96, 360)小时的后续合计费用的折扣价，后付费模式使用，单位：元 */
UnitPriceDiscountSecondStep?: number | null;
/** 使用时间区间在(360, ∞)小时的后续合计费用的原价，后付费模式使用，单位：元。 */
UnitPriceThirdStep?: number | null;
/** 使用时间区间在(360, ∞)小时的后续合计费用的折扣价，后付费模式使用，单位：元 */
UnitPriceDiscountThirdStep?: number | null;
/** 预支三年合计费用的原价，预付费模式使用，单位：元。 */
OriginalPriceThreeYear?: number | null;
/** 预支三年合计费用的折扣价，预付费模式使用，单位：元。 */
DiscountPriceThreeYear?: number | null;
/** 预支三年应用的折扣，如20.0代表2折。 */
DiscountThreeYear?: number | null;
/** 预支五年合计费用的原价，预付费模式使用，单位：元。 */
OriginalPriceFiveYear?: number | null;
/** 预支五年合计费用的折扣价，预付费模式使用，单位：元。 */
DiscountPriceFiveYear?: number | null;
/** 预支五年应用的折扣，如20.0代表2折。 */
DiscountFiveYear?: number | null;
/** 预支一年合计费用的原价，预付费模式使用，单位：元。 */
OriginalPriceOneYear?: number | null;
/** 预支一年合计费用的折扣价，预付费模式使用，单位：元。 */
DiscountPriceOneYear?: number | null;
/** 预支一年应用的折扣，如20.0代表2折。 */
DiscountOneYear?: number | null;
}
/** 作业 */
declare interface Job {
/** 任务信息 */
Tasks: Task[];
/** 作业名称 */
JobName?: string;
/** 作业描述 */
JobDescription?: string;
/** 作业优先级，任务（Task）和任务实例（TaskInstance）会继承作业优先级 */
Priority?: number;
/** 依赖信息 */
Dependences?: Dependence[];
/** 通知信息 */
Notifications?: Notification[];
/** 对于存在依赖关系的任务中，后序任务执行对于前序任务的依赖条件。取值范围包括 PRE_TASK_SUCCEED，PRE_TASK_AT_LEAST_PARTLY_SUCCEED，PRE_TASK_FINISHED，默认值为PRE_TASK_SUCCEED。 */
TaskExecutionDependOn?: string;
/** 表示创建 CVM 失败按照何种策略处理。取值范围包括 FAILED，RUNNABLE。FAILED 表示创建 CVM 失败按照一次执行失败处理，RUNNABLE 表示创建 CVM 失败按照继续等待处理。默认值为FAILED。StateIfCreateCvmFailed对于提交的指定计算环境的作业无效。 */
StateIfCreateCvmFailed?: string;
/** 标签列表。通过指定该参数可以支持绑定标签到作业。每个作业最多绑定10个标签。 */
Tags?: Tag[];
/** 表示通知信息的通知目标类型。取值范围：CMQ，TDMQ_CMQ。CMQ:表示向腾讯云CMQ发送消息。TDMQ_CMQ：表示向腾讯云TDMQ_CMQ发送消息。默认值为CMQ。注：腾讯云计划于2022年6月前正式下线消息队列 CMQ，建议使用TDMQ_CMQ。参考文档：[CMQ迁移到TDMQ_CMQ](https://cloud.tencent.com/document/product/406/60860) */
NotificationTarget?: string;
}
/** 作业信息 */
declare interface JobView {
/** 作业ID */
JobId?: string;
/** 作业名称 */
JobName?: string;
/** 作业状态 */
JobState?: string;
/** 作业优先级 */
Priority?: number;
/** 位置信息 */
Placement?: Placement | null;
/** 创建时间 */
CreateTime?: string;
/** 结束时间 */
EndTime?: string | null;
/** 任务统计指标 */
TaskMetrics?: TaskMetrics;
/** 作业绑定的标签列表。 */
Tags?: Tag[] | null;
}
/** 本地磁盘规格 */
declare interface LocalDiskType {
/** 本地磁盘类型。 */
Type?: string;
/** 本地磁盘属性。 */
PartitionType?: string;
/** 本地磁盘最小值。 */
MinSize?: number;
/** 本地磁盘最大值。 */
MaxSize?: number;
/** 购买时本地盘是否为必选。取值范围：REQUIRED：表示必选OPTIONAL：表示可选。 */
Required?: string;
}
/** 描述了实例登录相关配置与信息。 */
declare interface LoginSettings {
/** 实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? \/ ]中的特殊符号。 Windows实例密码必须12到16位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? \/]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。 */
Password?: string;
/** 密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。 */
KeyIds?: string[];
/** 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围：TRUE：表示保持镜像的登录设置FALSE：表示不保持镜像的登录设置默认取值：FALSE。 */
KeepImageLogin?: string;
}
/** 数据盘挂载选项 */
declare interface MountDataDisk {
/** 挂载点，Linux系统合法路径，或Windows系统盘符,比如"H:\\" */
LocalPath: string | null;
/** 文件系统类型，Linux系统下支持"EXT3"和"EXT4"两种，默认"EXT3"；Windows系统下仅支持"NTFS" */
FileSystemType?: string | null;
}
/** 计算环境 */
declare interface NamedComputeEnv {
/** 计算环境名称 */
EnvName: string;
/** 计算节点期望个数 */
DesiredComputeNodeCount: number;
/** 计算环境描述 */
EnvDescription?: string;
/** 计算环境管理类型 */
EnvType?: string;
/** 计算环境具体参数 */
EnvData?: EnvData;
/** 数据盘挂载选项 */
MountDataDisks?: MountDataDisk[];
/** 授权信息 */
Authentications?: Authentication[];
/** 输入映射信息 */
InputMappings?: InputMapping[];
/** agent运行模式，适用于Windows系统 */
AgentRunningMode?: AgentRunningMode;
/** 通知信息 */
Notifications?: Notification[];
/** 非活跃节点处理策略，默认“RECREATE”，即对于实例创建失败或异常退还的计算节点，定期重新创建实例资源。 */
ActionIfComputeNodeInactive?: string;
/** 对于实例创建失败或异常退还的计算节点，定期重新创建实例资源的最大重试次数，最大值100，如果不设置的话，系统会设置一个默认值，当前为7 */
ResourceMaxRetryCount?: number;
/** 标签列表。通过指定该参数可以支持绑定标签到计算环境。每个计算环境最多绑定10个标签。 */
Tags?: Tag[];
/** 表示通知信息的通知目标类型。取值范围：CMQ，TDMQ_CMQ。CMQ:表示向腾讯云CMQ发送消息。TDMQ_CMQ：表示向腾讯云TDMQ_CMQ发送消息。默认值为CMQ。注：腾讯云计划于2022年6月前正式下线消息队列 CMQ，建议使用TDMQ_CMQ。参考文档：[CMQ迁移到TDMQ_CMQ](https://cloud.tencent.com/document/product/406/60860) */
NotificationTarget?: string;
}
/** 黑石计算环境 */
declare interface NamedCpmComputeEnv {
/** 计算环境名称 */
EnvName: string;
/** 计算环境具体参数 */
EnvData: EnvDataCpm;
/** 计算节点期望个数 */
DesiredComputeNodeCount: number;
/** 计算环境描述 */
EnvDescription?: string;
/** 计算环境管理类型， 取值MANAGED。 */
EnvType?: string;
/** 授权信息 */
Authentications?: Authentication[];
/** 输入映射信息 */
InputMappings?: InputMapping[];
/** 通知信息 */
Notifications?: Notification;
/** 非活跃节点处理策略，默认“RECREATE”，即对于实例创建失败或异常退还的计算节点，定期重新创建实例资源。 */
ActionIfComputeNodeInactive?: string;
/** 对于实例创建失败或异常退还的计算节点，定期重新创建实例资源的最大重试次数，最大值100，如果不设置的话，系统会设置一个默认值，当前为7。 */
ResourceMaxRetryCount?: number;
/** 标签列表。通过指定该参数可以支持绑定标签到黑石计算环境。每个黑石计算环境最多绑定10个标签。 */
Tags?: Tag[];
/** 表示通知信息的通知目标类型。取值范围：CMQ，TDMQ_CMQ。CMQ:表示向腾讯云CMQ发送消息。TDMQ_CMQ：表示向腾讯云TDMQ_CMQ发送消息。默认值为CMQ。注：腾讯云计划于2022年6月前正式下线消息队列 CMQ，建议使用TDMQ_CMQ。参考文档：[CMQ迁移到TDMQ_CMQ](https://cloud.tencent.com/document/product/406/60860) */
NotificationTarget?: string;
}
/** 通知信息 */
declare interface Notification {
/** CMQ主题名字，要求主题名有效且关联订阅 */
TopicName: string | null;
/** 事件配置 */
EventConfigs: EventConfig[] | null;
}
/** 操作系统类型 */
declare interface OsInfo {
/** 操作系统ID。 */
OsTypeId?: number;
/** 操作系统名称。 */
OsName?: string;
/** 操作系统名称描述。 */
OsDescription?: string;
/** 操作系统英文名称。 */
OsEnglishDescription?: string;
/** 操作系统的分类，如CentOs Debian。 */
OsClass?: string;
/** 标识镜像分类。public:公共镜像; private: 专属镜像。 */
ImageTag?: string;
/** 操作系统，ext4文件下所支持的最大的磁盘大小。单位为T。 */
MaxPartitionSize?: number;
}
/** 输出映射 */
declare interface OutputMapping {
/** 源端路径 */
SourcePath: string;
/** 目的端路径 */
DestinationPath: string;
/** 输出映射选项 */
OutputMappingOption?: OutputMappingOption | null;
}
/** 输出映射配置 */
declare interface OutputMappingConfig {
/** 存储类型，仅支持COS */
Scene: string;
/** 并行worker数量 */
WorkerNum: number;
/** worker分块大小，单位MB */
WorkerPartSize: number;
}
/** 输出映射选项 */
declare interface OutputMappingOption {
/** 容器场景下,输出选项从实例映射到容器内的实例侧的工作空间。BATCH_WORKSPACE: 工作空间为BATCH在实例内定义的工作空间，BATCH侧保证作业之间的隔离。（默认）GLOBAL_WORKSPACE: 工作空间为实例操作系统空间。 */
Workspace?: string | null;
}
/** 描述了实例的抽象位置，包括其所在的可用区，所属的项目，宿主机（仅专用宿主机产品可用），母机IP等 */
declare interface Placement {
/** 实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。 */
Zone: string;
/** 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */
ProjectId?: number;
/** 实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。 */
HostIds?: string[];
/** 实例所属的专用宿主机ID，仅用于出参。 */
HostId?: string;
}
/** 重定向信息 */
declare interface RedirectInfo {
/** 标准输出重定向路径; */
StdoutRedirectPath?: string | null;
/** 标准错误重定向路径 */
StderrRedirectPath?: string | null;
/** 标准输出重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} */
StdoutRedirectFileName?: string | null;
/** 标准错误重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} */
StderrRedirectFileName?: string | null;
}
/** 本地重定向信息 */
declare interface RedirectLocalInfo {
/** 标准输出重定向本地路径 */
StdoutLocalPath?: string | null;
/** 标准错误重定向本地路径 */
StderrLocalPath?: string | null;
/** 标准输出重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} */
StdoutLocalFileName?: string | null;
/** 标准错误重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} */
StderrLocalFileName?: string | null;
}
/** 描述了 “云自动化助手” 服务相关的信息 */
declare interface RunAutomationServiceEnabled {
/** 是否开启云自动化助手。取值范围：true：表示开启云自动化助手服务false：表示不开启云自动化助手服务默认取值：false。 */
Enabled?: boolean;
}
/** 描述了 “云监控” 服务相关的信息 */
declare interface RunMonitorServiceEnabled {
/** 是否开启[云监控](/document/product/248)服务。取值范围：true：表示开启云监控服务false：表示不开启云监控服务默认取值：true。 */
Enabled?: boolean | null;
}
/** 描述了 “云安全” 服务相关的信息 */
declare interface RunSecurityServiceEnabled {
/** 是否开启[云安全](/document/product/296)服务。取值范围：true：表示开启云安全服务false：表示不开启云安全服务默认取值：true。 */
Enabled?: boolean;
}
/** 竞价相关选项 */
declare interface SpotMarketOptions {
/** 竞价出价 */
MaxPrice: string | null;
/** 竞价请求类型，当前仅支持类型：one-time */
SpotInstanceType?: string | null;
}
/** HDD的本地存储信息 */
declare interface StorageBlock {
/** HDD本地存储类型，值为：LOCAL_PRO. */
Type?: string | null;
/** HDD本地存储的最小容量 */
MinSize?: number | null;
/** HDD本地存储的最大容量 */
MaxSize?: number | null;
}
/** 描述了操作系统所在块设备即系统盘的信息 */
declare interface SystemDisk {
/** 系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘LOCAL_SSD：本地SSD硬盘CLOUD_BASIC：普通云硬盘CLOUD_SSD：SSD云硬盘CLOUD_PREMIUM：高性能云硬盘CLOUD_BSSD：通用型SSD云硬盘CLOUD_HSSD：增强型SSD云硬盘CLOUD_TSSD：极速型SSD云硬盘默认取值：当前有库存的硬盘类型。 */
DiskType?: string;
/** 系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。 */
DiskId?: string;
/** 系统盘大小，单位：GB。默认值为 50 */
DiskSize?: number;
/** 所属的独享集群ID。 */
CdcId?: string | null;
/** 磁盘名称，长度不超过128 个字符。该参数正在邀测中，暂未开放使用。 */
DiskName?: string | null;
}
/** 标签。 */
declare interface Tag {
/** 标签键。 */
Key: string | null;
/** 标签值。 */
Value: string | null;
}
/** 任务 */
declare interface Task {
/** 应用程序信息 */
Application: Application;
/** 任务名称，在一个作业内部唯一 */
TaskName?: string;
/** 任务实例运行个数，默认为1 */
TaskInstanceNum?: number;
/** 运行环境信息，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。 */
ComputeEnv?: AnonymousComputeEnv;
/** 计算环境ID，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。 */
EnvId?: string;
/** 重定向信息 */
RedirectInfo?: RedirectInfo;
/** 重定向本地信息 */
RedirectLocalInfo?: RedirectLocalInfo;
/** 输入映射 */
InputMappings?: InputMapping[];
/** 输出映射 */
OutputMappings?: OutputMapping[];
/** 输出映射配置 */
OutputMappingConfigs?: OutputMappingConfig[];
/** 自定义环境变量 */
EnvVars?: EnvVar[];
/** 授权信息 */
Authentications?: Authentication[];
/** TaskInstance失败后处理方式，取值包括TERMINATE（默认）、INTERRUPT、FAST_INTERRUPT。 */
FailedAction?: string;
/** 任务失败后的最大重试次数，默认为0 */
MaxRetryCount?: number;
/** 任务启动后的超时时间，单位秒，默认为86400秒 */
Timeout?: number;
/** 任务最大并发数限制，默认没有限制。 */
MaxConcurrentNum?: number;
/** 任务完成后，重启计算节点。适用于指定计算环境执行任务。 */
RestartComputeNode?: boolean;
/** 启动任务过程中，创建计算资源如CVM失败后的最大重试次数，默认为0。最大值100。计算资源创建重试的等待时间间隔策略设置如下：[1, 3]: 等待600 s发起重试；[4, 10]: 等待900 s发起重试；[11, 50]: 等待1800 s发起重试；[51, 100]: 等待3600 s发起重试；[a, b]表示重试次数区间，每次重试的等待时间随着重试次数的增加而递增。例如，计算资源创建重试8次的耗时为：3*600 + 5*900 = 6300 s */
ResourceMaxRetryCount?: number;
}
/** 任务实例日志详情。 */
declare interface TaskInstanceLog {
/** 任务实例 */
TaskInstanceIndex?: number;
/** 标准输出日志（Base64编码，解码后最大日志长度2048字节） */
StdoutLog?: string | null;
/** 标准错误日志（Base64编码，解码后最大日志长度2048字节） */
StderrLog?: string | null;
/** 标准输出重定向路径 */
StdoutRedirectPath?: string | null;
/** 标准错误重定向路径 */
StderrRedirectPath?: string | null;
/** 标准输出重定向文件名 */
StdoutRedirectFileName?: string | null;
/** 标准错误重定向文件名 */
StderrRedirectFileName?: string | null;
}
/** 任务实例统计指标 */
declare interface TaskInstanceMetrics {
/** Submitted个数 */
SubmittedCount?: number | null;
/** Pending个数 */
PendingCount?: number | null;
/** Runnable个数 */
RunnableCount?: number | null;
/** Starting个数 */
StartingCount?: number | null;
/** Running个数 */
RunningCount?: number | null;
/** Succeed个数 */
SucceedCount?: number | null;
/** FailedInterrupted个数 */
FailedInterruptedCount?: number | null;
/** Failed个数 */
FailedCount?: number | null;
}
/** 任务实例视图信息 */
declare interface TaskInstanceView {
/** 任务实例索引 */
TaskInstanceIndex?: number;
/** 任务实例状态 */
TaskInstanceState?: string;
/** 应用程序执行结束的exit code */
ExitCode?: number | null;
/** 任务实例状态原因，任务实例失败时，会记录失败原因 */
StateReason?: string;
/** 任务实例运行时所在计算节点（例如CVM）的InstanceId。任务实例未运行或者完结时，本字段为空。任务实例重试时，本字段会随之变化 */
ComputeNodeInstanceId?: string | null;
/** 创建时间 */
CreateTime?: string;
/** 启动时间 */
LaunchTime?: string | null;
/** 开始运行时间 */
RunningTime?: string | null;
/** 结束时间 */
EndTime?: string | null;
/** 重定向信息 */
RedirectInfo?: RedirectInfo;
/** 任务实例状态原因详情，任务实例失败时，会记录失败原因 */
StateDetailedReason?: string;
}
/** 任务统计指标 */
declare interface TaskMetrics {
/** Submitted个数 */
SubmittedCount?: number | null;
/** Pending个数 */
PendingCount?: number | null;
/** Runnable个数 */
RunnableCount?: number | null;
/** Starting个数 */
StartingCount?: number | null;
/** Running个数 */
RunningCount?: number | null;
/** Succeed个数 */
SucceedCount?: number | null;
/** FailedInterrupted个数 */
FailedInterruptedCount?: number | null;
/** Failed个数 */
FailedCount?: number | null;
}
/** 任务模板信息 */
declare interface TaskTemplateView {
/** 任务模板ID */
TaskTemplateId?: string;
/** 任务模板名称 */
TaskTemplateName?: string;
/** 任务模板描述 */
TaskTemplateDescription?: string;
/** 任务模板信息 */
TaskTemplateInfo?: Task;
/** 创建时间 */
CreateTime?: string;
/** 任务模板绑定的标签列表。 */
Tags?: Tag[] | null;
}
/** 任务视图信息 */
declare interface TaskView {
/** 任务名称 */
TaskName?: string;
/** 任务状态 */
TaskState?: string;
/** 开始时间 */
CreateTime?: string;
/** 结束时间 */
EndTime?: string | null;
}
/** 描述了VPC相关信息，包括子网，IP信息等 */
declare interface VirtualPrivateCloud {
/** 私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcEx](/document/api/215/1372) ，从接口返回中的`unVpcId`字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。 */
VpcId: string;
/** 私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](/document/api/215/15784) ，从接口返回中的`unSubnetId`字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。 */
SubnetId: string;
/** 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。 */
AsVpcGateway?: boolean;
/** 私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。 */
PrivateIpAddresses?: string[];
/** 为弹性网卡指定随机生成的 IPv6 地址数量。 */
Ipv6AddressCount?: number;
}
declare interface AttachInstancesRequest {
/** 计算环境ID */
EnvId: string;
/** 加入计算环境实例列表 */
Instances: Instance[];
}
declare interface AttachInstancesResponse {
/** 唯一请求 ID，每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateComputeEnvRequest {
/** 计算环境信息 */
ComputeEnv: NamedComputeEnv;
/** 位置信息 */