tencentcloud-sdk-batch 3.0.1058 → 3.0.1059

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b531b1e7382330f883027f8c09fb574aa3d0e961
4
- data.tar.gz: a39d8b649f72e920e1e002e007d3104d2cd0d8f7
3
+ metadata.gz: 8ce54d6991ce1176b97eec7b40fd76f1802008e1
4
+ data.tar.gz: 6c6a82f6d372759bd5118f454ca395f1398152ea
5
5
  SHA512:
6
- metadata.gz: c2bf7ecce193365281c21096c601ab8d5ad534c4d6b445c2b9a1d4eb299a24b2eaeae1db6dfe9a65d764966f6c8b092b6191d9d7fc626342e3ad36456e62c65b
7
- data.tar.gz: 8c0311bc47bbcafee68ce5d31115b67307c6219b58eebddd4b5cb9bf32c853c718943e526ead860eadfa06193d08931a6bff37fa855f20433d6a52a4bd654cf9
6
+ metadata.gz: 0a3f45bce7a24c96eb70c5b11a89117b08a3b71cd4d1f6ed7da7de89926b1cfac851645a2810b4719e93072ab64acaddfbc86929ea055713b87bdba114ec6ad3
7
+ data.tar.gz: ea583a70861111a7805afa30609afa0b851943163807353ea081c808a950017bca9c0811e4a66b525843856dd2db1c165130497cd09e952b93b7d84dd93864d8
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1058
1
+ 3.0.1059
@@ -590,7 +590,7 @@ module TencentCloud
590
590
  end
591
591
 
592
592
  # 用于重试作业中失败的任务实例。
593
- # 当且仅当作业处于“FAILED”状态,支持重试操作。重试操作成功后,作业会按照“DAG”中指定的任务依赖关系,依次重试各个任务中失败的任务实例。任务实例的历史信息将被重置,如同首次运行一样,参与后续的调度和执行。
593
+ # 仅当作业处于“FAILED”状态,支持重试操作。重试操作成功后,作业会按照有向无环图中指定的任务依赖关系,依次重试各个任务中失败的任务实例。任务实例的历史信息将被重置,如同首次运行一样,参与后续的调度和执行。
594
594
 
595
595
  # @param request: Request instance for RetryJobs.
596
596
  # @type request: :class:`Tencentcloud::batch::V20170312::RetryJobsRequest`
@@ -689,7 +689,7 @@ module TencentCloud
689
689
 
690
690
  # 用于终止作业。
691
691
  # 当作业处于“SUBMITTED”状态时,禁止终止操作;当作业处于“SUCCEED”状态时,终止操作不会生效。
692
- # 终止作业是一个异步过程。整个终止过程的耗时和任务总数成正比。终止的效果相当于所含的所有任务实例进行TerminateTaskInstance操作。具体效果和用法可参考TerminateTaskInstance。
692
+ # 终止作业是一个异步过程。整个终止过程的耗时和任务总数成正比。终止的效果相当于所含的所有任务实例进行[TerminateTaskInstance](https://cloud.tencent.com/document/product/599/15908)操作。具体效果和用法可参考[TerminateTaskInstance](https://cloud.tencent.com/document/product/599/15908)
693
693
 
694
694
  # @param request: Request instance for TerminateJob.
695
695
  # @type request: :class:`Tencentcloud::batch::V20170312::TerminateJobRequest`
@@ -716,7 +716,7 @@ module TencentCloud
716
716
  # 用于终止任务实例。
717
717
  # 对于状态已经为“SUCCEED”和“FAILED”的任务实例,不做处理。
718
718
  # 对于状态为“SUBMITTED”、“PENDING”、“RUNNABLE”的任务实例,状态将置为“FAILED”状态。
719
- # 对于状态为“STARTING”、“RUNNING”、“FAILED_INTERRUPTED”的任务实例,分区两种情况:如果未显示指定计算环境,会先销毁CVM服务器,然后将状态置为“FAILED”,具有一定耗时;如果指定了计算环境EnvId,任务实例状态置为“FAILED”,并重启执行该任务的CVM服务器,具有一定的耗时。
719
+ # 对于状态为“STARTING”、“RUNNING”、“FAILED_INTERRUPTED”的任务实例,区分两种情况:如果未显示指定计算环境,会先销毁CVM服务器,然后将状态置为“FAILED”,具有一定耗时;如果指定了计算环境EnvId,任务实例状态置为“FAILED”,并重启执行该任务的CVM服务器,具有一定的耗时。
720
720
  # 对于状态为“FAILED_INTERRUPTED”的任务实例,终止操作实际成功之后,相关资源和配额才会释放。
721
721
 
722
722
  # @param request: Request instance for TerminateTaskInstance.
@@ -29,7 +29,7 @@ module TencentCloud
29
29
  # @type EnvId: String
30
30
  # @param Cause: 起因
31
31
  # @type Cause: String
32
- # @param ActivityState: 活动状态
32
+ # @param ActivityState: 活动状态。取值范围:<br><li>SUBMITTED:已提交</li><li>PROCESSING:处理中</li><li>SUCCEED:成功</li><li>FAILED:失败</li>
33
33
  # @type ActivityState: String
34
34
  # @param StateReason: 状态原因
35
35
  # @type StateReason: String
@@ -138,13 +138,13 @@ module TencentCloud
138
138
  class Application < TencentCloud::Common::AbstractModel
139
139
  # @param DeliveryForm: 应用程序的交付方式,包括PACKAGE、LOCAL 两种取值,分别指远程存储的软件包、计算环境本地。
140
140
  # @type DeliveryForm: String
141
- # @param Command: 任务执行命令。与Commands不能同时指定。
141
+ # @param Command: 松耦合任务执行命令。与Commands不能同时指定,一般使用Command字段提交任务。
142
142
  # @type Command: String
143
143
  # @param PackagePath: 应用程序软件包的远程存储路径
144
144
  # @type PackagePath: String
145
145
  # @param Docker: 应用使用Docker的相关配置。在使用Docker配置的情况下,DeliveryForm 为 LOCAL 表示直接使用Docker镜像内部的应用软件,通过Docker方式运行;DeliveryForm 为 PACKAGE,表示将远程应用包注入到Docker镜像后,通过Docker方式运行。为避免Docker不同版本的兼容性问题,Docker安装包及相关依赖由Batch统一负责,对于已安装Docker的自定义镜像,请卸载后再使用Docker特性。
146
146
  # @type Docker: :class:`Tencentcloud::Batch.v20170312.models.Docker`
147
- # @param Commands: 任务执行命令信息。与Command不能同时指定。
147
+ # @param Commands: 紧耦合任务执行命令信息。与Command不能同时指定。Command和Commands必须指定一个。
148
148
  # @type Commands: Array
149
149
 
150
150
  attr_accessor :DeliveryForm, :Command, :PackagePath, :Docker, :Commands
@@ -178,9 +178,9 @@ module TencentCloud
178
178
 
179
179
  # AttachInstances请求参数结构体
180
180
  class AttachInstancesRequest < TencentCloud::Common::AbstractModel
181
- # @param EnvId: 计算环境ID
181
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
182
182
  # @type EnvId: String
183
- # @param Instances: 加入计算环境实例列表
183
+ # @param Instances: 加入计算环境实例列表,每次请求的实例的上限为100。
184
184
  # @type Instances: Array
185
185
 
186
186
  attr_accessor :EnvId, :Instances
@@ -445,7 +445,7 @@ module TencentCloud
445
445
  # @type ComputeNodeId: String
446
446
  # @param ComputeNodeInstanceId: 计算节点实例ID,对于CVM场景,即为CVM的InstanceId
447
447
  # @type ComputeNodeInstanceId: String
448
- # @param ComputeNodeState: 计算节点状态
448
+ # @param ComputeNodeState: 计算节点状态。取值范围:<br><li>PENDING:表示创建中</li><li>SUBMITTED:表示已提交创建</li><li>CREATING:表示创建中</li><li>CREATED:表示创建完成</li><li>CREATION_FAILED:表示创建失败。</li><li>RUNNING:表示运行中。</li><li>ABNORMAL:表示节点异常。</li><li>DELETING:表示删除中。</li>
449
449
  # @type ComputeNodeState: String
450
450
  # @param Cpu: CPU核数
451
451
  # @type Cpu: Integer
@@ -592,11 +592,11 @@ module TencentCloud
592
592
 
593
593
  # CreateTaskTemplate请求参数结构体
594
594
  class CreateTaskTemplateRequest < TencentCloud::Common::AbstractModel
595
- # @param TaskTemplateName: 任务模板名称
595
+ # @param TaskTemplateName: 任务模板名称,最大长度限制60个字符。
596
596
  # @type TaskTemplateName: String
597
597
  # @param TaskTemplateInfo: 任务模板内容,参数要求与任务一致
598
598
  # @type TaskTemplateInfo: :class:`Tencentcloud::Batch.v20170312.models.Task`
599
- # @param TaskTemplateDescription: 任务模板描述
599
+ # @param TaskTemplateDescription: 任务模板描述,最大长度限制200个字符。
600
600
  # @type TaskTemplateDescription: String
601
601
  # @param Tags: 标签列表。通过指定该参数可以支持绑定标签到任务模板。每个任务模板最多绑定10个标签。
602
602
  # @type Tags: Array
@@ -712,7 +712,7 @@ module TencentCloud
712
712
 
713
713
  # DeleteComputeEnv请求参数结构体
714
714
  class DeleteComputeEnvRequest < TencentCloud::Common::AbstractModel
715
- # @param EnvId: 计算环境ID
715
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
716
716
  # @type EnvId: String
717
717
 
718
718
  attr_accessor :EnvId
@@ -744,7 +744,7 @@ module TencentCloud
744
744
 
745
745
  # DeleteJob请求参数结构体
746
746
  class DeleteJobRequest < TencentCloud::Common::AbstractModel
747
- # @param JobId: 作业ID
747
+ # @param JobId: 作业ID;JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)
748
748
  # @type JobId: String
749
749
 
750
750
  attr_accessor :JobId
@@ -776,7 +776,7 @@ module TencentCloud
776
776
 
777
777
  # DeleteTaskTemplates请求参数结构体
778
778
  class DeleteTaskTemplatesRequest < TencentCloud::Common::AbstractModel
779
- # @param TaskTemplateIds: 用于删除任务模板信息
779
+ # @param TaskTemplateIds: 用于删除任务模板信息,最大数量上限100,环境模版ID通过调用接口 [DescribeTaskTemplates](https://cloud.tencent.com/document/api/599/15902)获取。
780
780
  # @type TaskTemplateIds: Array
781
781
 
782
782
  attr_accessor :TaskTemplateIds
@@ -829,8 +829,8 @@ module TencentCloud
829
829
  # DescribeAvailableCvmInstanceTypes请求参数结构体
830
830
  class DescribeAvailableCvmInstanceTypesRequest < TencentCloud::Common::AbstractModel
831
831
  # @param Filters: 过滤条件。
832
- # <li> zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。</li>
833
- # <li> instance-family String - 是否必填:否 -(过滤条件)按照机型系列过滤。实例机型系列形如:S1、I1、M1等。</li>
832
+ # <li> zone - String - 是否必填:否 -(过滤条件)按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。</li>
833
+ # <li> instance-family String - 是否必填:否 -(过滤条件)按照[机型系列](https://cloud.tencent.com/document/product/213/15748)过滤。实例机型系列形如:S1、I1、M1等。</li>
834
834
  # @type Filters: Array
835
835
 
836
836
  attr_accessor :Filters
@@ -880,11 +880,11 @@ module TencentCloud
880
880
 
881
881
  # DescribeComputeEnvActivities请求参数结构体
882
882
  class DescribeComputeEnvActivitiesRequest < TencentCloud::Common::AbstractModel
883
- # @param EnvId: 计算环境ID
883
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
884
884
  # @type EnvId: String
885
- # @param Offset: 偏移量
885
+ # @param Offset: 偏移量,默认为0.
886
886
  # @type Offset: Integer
887
- # @param Limit: 返回数量
887
+ # @param Limit: 返回数量,默认值20,最大值100.
888
888
  # @type Limit: Integer
889
889
  # @param Filters: 过滤条件
890
890
  # <li> compute-node-id - String - 是否必填:否 -(过滤条件)按照计算节点ID过滤。</li>
@@ -943,7 +943,7 @@ module TencentCloud
943
943
 
944
944
  # DescribeComputeEnvCreateInfo请求参数结构体
945
945
  class DescribeComputeEnvCreateInfoRequest < TencentCloud::Common::AbstractModel
946
- # @param EnvId: 计算环境ID
946
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
947
947
  # @type EnvId: String
948
948
 
949
949
  attr_accessor :EnvId
@@ -1058,17 +1058,13 @@ module TencentCloud
1058
1058
 
1059
1059
  # DescribeComputeEnvCreateInfos请求参数结构体
1060
1060
  class DescribeComputeEnvCreateInfosRequest < TencentCloud::Common::AbstractModel
1061
- # @param EnvIds: 计算环境ID列表,与Filters参数不能同时指定。
1061
+ # @param EnvIds: 计算环境ID列表,与Filters参数不能同时指定,最大限制100。环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
1062
1062
  # @type EnvIds: Array
1063
- # @param Filters: 过滤条件
1064
- # <li> zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。</li>
1065
- # <li> env-id - String - 是否必填:否 -(过滤条件)按照计算环境ID过滤。</li>
1066
- # <li> env-name - String - 是否必填:否 -(过滤条件)按照计算环境名称过滤。</li>
1067
- # 与EnvIds参数不能同时指定。
1063
+ # @param Filters: 过滤条件<li> zone - String - 是否必填:否 -(过滤条件)按照可用区过滤,可用区通过调用接口 [DescribeZones](https://cloud.tencent.com/document/api/213/15707)获取。</li><li> env-id - String - 是否必填:否 -(过滤条件)按照计算环境ID过滤。</li><li> env-name - String - 是否必填:否 -(过滤条件)按照计算环境名称过滤。</li>与EnvIds参数不能同时指定。
1068
1064
  # @type Filters: Array
1069
1065
  # @param Offset: 偏移量
1070
1066
  # @type Offset: Integer
1071
- # @param Limit: 返回数量
1067
+ # @param Limit: 返回数量,默认值20,最大值100。
1072
1068
  # @type Limit: Integer
1073
1069
 
1074
1070
  attr_accessor :EnvIds, :Filters, :Offset, :Limit
@@ -1144,7 +1140,7 @@ module TencentCloud
1144
1140
 
1145
1141
  # DescribeComputeEnv返回参数结构体
1146
1142
  class DescribeComputeEnvResponse < TencentCloud::Common::AbstractModel
1147
- # @param EnvId: 计算环境ID
1143
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
1148
1144
  # @type EnvId: String
1149
1145
  # @param EnvName: 计算环境名称
1150
1146
  # @type EnvName: String
@@ -1158,11 +1154,11 @@ module TencentCloud
1158
1154
  # @type ComputeNodeMetrics: :class:`Tencentcloud::Batch.v20170312.models.ComputeNodeMetrics`
1159
1155
  # @param DesiredComputeNodeCount: 计算节点期望个数
1160
1156
  # @type DesiredComputeNodeCount: Integer
1161
- # @param EnvType: 计算环境类型
1157
+ # @param EnvType: 计算环境管理类型,枚举如下: MANAGED: 由客户在Batch平台主动创建; THPC_QUEUE: 由thpc平台创建,关联thpc平台集群队列。
1162
1158
  # @type EnvType: String
1163
1159
  # @param ResourceType: 计算环境资源类型,当前为CVM和CPM(黑石)
1164
1160
  # @type ResourceType: String
1165
- # @param NextAction: 下一步动作
1161
+ # @param NextAction: 下一步的动作,枚举如下: DELETING: 删除中
1166
1162
  # @type NextAction: String
1167
1163
  # @param AttachedComputeNodeCount: 用户添加到计算环境中的计算节点个数
1168
1164
  # @type AttachedComputeNodeCount: Integer
@@ -1229,21 +1225,13 @@ module TencentCloud
1229
1225
 
1230
1226
  # DescribeComputeEnvs请求参数结构体
1231
1227
  class DescribeComputeEnvsRequest < TencentCloud::Common::AbstractModel
1232
- # @param EnvIds: 计算环境ID列表,与Filters参数不能同时指定。
1228
+ # @param EnvIds: 计算环境ID列表,与Filters参数不能同时指定。最大数量上限100,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
1233
1229
  # @type EnvIds: Array
1234
- # @param Filters: 过滤条件
1235
- # <li> zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。</li>
1236
- # <li> env-id - String - 是否必填:否 -(过滤条件)按照计算环境ID过滤。</li>
1237
- # <li> env-name - String - 是否必填:否 -(过滤条件)按照计算环境名称过滤。</li>
1238
- # <li> resource-type - String - 是否必填:否 -(过滤条件)按照计算资源类型过滤,取值CVM或者CPM(黑石)。</li>
1239
- # <li> tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。</li>
1240
- # <li>tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。</li>
1241
- # <li>tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。</li>
1242
- # 与EnvIds参数不能同时指定。
1230
+ # @param Filters: 过滤条件<li> zone - String - 是否必填:否 -(过滤条件)按照可用区过滤,可用区通过调用接口 [DescribeZones](https://cloud.tencent.com/document/api/213/15707)获取。</li><li> env-id - String - 是否必填:否 -(过滤条件)按照计算环境ID过滤。</li><li> env-name - String - 是否必填:否 -(过滤条件)按照计算环境名称过滤。</li><li> resource-type - String - 是否必填:否 -(过滤条件)按照计算资源类型过滤,取值CVM或者CPM(黑石)。</li><li> tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。</li><li>tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。</li><li>tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。</li>与EnvIds参数不能同时指定。
1243
1231
  # @type Filters: Array
1244
1232
  # @param Offset: 偏移量
1245
1233
  # @type Offset: Integer
1246
- # @param Limit: 返回数量
1234
+ # @param Limit: 返回数量,默认值20,最大值100。
1247
1235
  # @type Limit: Integer
1248
1236
 
1249
1237
  attr_accessor :EnvIds, :Filters, :Offset, :Limit
@@ -1304,9 +1292,9 @@ module TencentCloud
1304
1292
  # DescribeCvmZoneInstanceConfigInfos请求参数结构体
1305
1293
  class DescribeCvmZoneInstanceConfigInfosRequest < TencentCloud::Common::AbstractModel
1306
1294
  # @param Filters: 过滤条件。
1307
- # <li> zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。</li>
1308
- # <li> instance-family String - 是否必填:否 -(过滤条件)按照机型系列过滤。实例机型系列形如:S1、I1、M1等。</li>
1309
- # <li> instance-type - String - 是否必填:否 - (过滤条件)按照机型过滤。</li>
1295
+ # <li> zone - String - 是否必填:否 -(过滤条件)按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。</li>
1296
+ # <li> instance-family String - 是否必填:否 -(过滤条件)按照[机型系列](https://cloud.tencent.com/document/product/213/15748)过滤。实例机型系列形如:S1、I1、M1等。</li>
1297
+ # <li> instance-type - String - 是否必填:否 - (过滤条件)按照[机型](https://cloud.tencent.com/document/product/213/15749)过滤。实例机型形如::S5.12XLARGE128、S5.12XLARGE96等。</li>
1310
1298
  # <li> instance-charge-type - String - 是否必填:否 -(过滤条件)按照实例计费模式过滤。 ( POSTPAID_BY_HOUR:表示后付费,即按量计费机型 | SPOTPAID:表示竞价付费机型。 ) </li>
1311
1299
  # @type Filters: Array
1312
1300
 
@@ -1395,7 +1383,7 @@ module TencentCloud
1395
1383
 
1396
1384
  # DescribeJob请求参数结构体
1397
1385
  class DescribeJobRequest < TencentCloud::Common::AbstractModel
1398
- # @param JobId: 作业标识
1386
+ # @param JobId: 作业ID;JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)
1399
1387
  # @type JobId: String
1400
1388
 
1401
1389
  attr_accessor :JobId
@@ -1421,9 +1409,9 @@ module TencentCloud
1421
1409
  # @type Priority: Integer
1422
1410
  # @param JobState: 作业状态
1423
1411
  # @type JobState: String
1424
- # @param CreateTime: 创建时间
1412
+ # @param CreateTime: 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
1425
1413
  # @type CreateTime: String
1426
- # @param EndTime: 结束时间
1414
+ # @param EndTime: 结束时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
1427
1415
  # @type EndTime: String
1428
1416
  # @param TaskSet: 任务视图信息
1429
1417
  # @type TaskSet: Array
@@ -1599,7 +1587,17 @@ module TencentCloud
1599
1587
  # <li> job-id - String - 是否必填:否 -(过滤条件)按照作业ID过滤。</li>
1600
1588
  # <li> job-name - String - 是否必填:否 -(过滤条件)按照作业名称过滤。</li>
1601
1589
  # <li> job-state - String - 是否必填:否 -(过滤条件)按照作业状态过滤。</li>
1602
- # <li> zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。</li>
1590
+
1591
+ # - SUBMITTED:已提交;
1592
+ # - PENDING:等待中;
1593
+ # - RUNNABLE:可运行;
1594
+ # - STARTING:启动中;
1595
+ # - RUNNING:运行中;
1596
+ # - SUCCEED:成功;
1597
+ # - FAILED:失败;
1598
+ # - FAILED_INTERRUPTED:失败后保留实例。
1599
+
1600
+ # <li> zone - String - 是否必填:否 -(过滤条件)按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。</li>
1603
1601
  # <li> tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。</li>
1604
1602
  # <li> tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。</li>
1605
1603
  # <li> tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。</li>
@@ -1607,7 +1605,7 @@ module TencentCloud
1607
1605
  # @type Filters: Array
1608
1606
  # @param Offset: 偏移量
1609
1607
  # @type Offset: Integer
1610
- # @param Limit: 返回数量
1608
+ # @param Limit: 返回job数量限制,最大值: 100,默认值: 20.
1611
1609
  # @type Limit: Integer
1612
1610
 
1613
1611
  attr_accessor :JobIds, :Filters, :Offset, :Limit
@@ -1667,15 +1665,15 @@ module TencentCloud
1667
1665
 
1668
1666
  # DescribeTaskLogs请求参数结构体
1669
1667
  class DescribeTaskLogsRequest < TencentCloud::Common::AbstractModel
1670
- # @param JobId: 作业ID
1668
+ # @param JobId: 作业ID。JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)。
1671
1669
  # @type JobId: String
1672
1670
  # @param TaskName: 任务名称
1673
1671
  # @type TaskName: String
1674
- # @param TaskInstanceIndexes: 任务实例集合
1672
+ # @param TaskInstanceIndexes: 任务实例集合;与Offset不能同时指定。
1675
1673
  # @type TaskInstanceIndexes: Array
1676
- # @param Offset: 起始任务实例
1674
+ # @param Offset: 起始任务实例。与TaskInstanceIndexes参数不能同时指定。
1677
1675
  # @type Offset: Integer
1678
- # @param Limit: 最大任务实例数
1676
+ # @param Limit: 最大任务实例数, 最大值为10.
1679
1677
  # @type Limit: Integer
1680
1678
 
1681
1679
  attr_accessor :JobId, :TaskName, :TaskInstanceIndexes, :Offset, :Limit
@@ -1730,7 +1728,7 @@ module TencentCloud
1730
1728
 
1731
1729
  # DescribeTask请求参数结构体
1732
1730
  class DescribeTaskRequest < TencentCloud::Common::AbstractModel
1733
- # @param JobId: 作业ID
1731
+ # @param JobId: 作业ID;JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)
1734
1732
  # @type JobId: String
1735
1733
  # @param TaskName: 任务名称
1736
1734
  # @type TaskName: String
@@ -1739,7 +1737,16 @@ module TencentCloud
1739
1737
  # @param Limit: 返回数量。默认取值100,最大取值1000。
1740
1738
  # @type Limit: Integer
1741
1739
  # @param Filters: 过滤条件,详情如下:
1742
- # <li> task-instance-type - String - 是否必填: 否 - 按照任务实例状态进行过滤(SUBMITTED:已提交;PENDING:等待中;RUNNABLE:可运行;STARTING:启动中;RUNNING:运行中;SUCCEED:成功;FAILED:失败;FAILED_INTERRUPTED:失败后保留实例)。</li>
1740
+ # task-instance-state - String - 是否必填: 否 - 按照任务实例状态进行过滤(
1741
+
1742
+ # - SUBMITTED:已提交;
1743
+ # - PENDING:等待中;
1744
+ # - RUNNABLE:可运行;
1745
+ # - STARTING:启动中;
1746
+ # - RUNNING:运行中;
1747
+ # - SUCCEED:成功;
1748
+ # - FAILED:失败;
1749
+ # - FAILED_INTERRUPTED:失败后保留实例)。
1743
1750
  # @type Filters: Array
1744
1751
 
1745
1752
  attr_accessor :JobId, :TaskName, :Offset, :Limit, :Filters
@@ -1899,9 +1906,9 @@ module TencentCloud
1899
1906
 
1900
1907
  # DetachInstances请求参数结构体
1901
1908
  class DetachInstancesRequest < TencentCloud::Common::AbstractModel
1902
- # @param EnvId: 计算环境ID
1909
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
1903
1910
  # @type EnvId: String
1904
- # @param InstanceIds: 实例ID列表
1911
+ # @param InstanceIds: 实例ID列表,实例ID通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728)获取。
1905
1912
  # @type InstanceIds: Array
1906
1913
 
1907
1914
  attr_accessor :EnvId, :InstanceIds
@@ -2639,11 +2646,11 @@ module TencentCloud
2639
2646
  class Job < TencentCloud::Common::AbstractModel
2640
2647
  # @param Tasks: 任务信息
2641
2648
  # @type Tasks: Array
2642
- # @param JobName: 作业名称
2649
+ # @param JobName: 作业名称; 字符串长度限制60.
2643
2650
  # @type JobName: String
2644
- # @param JobDescription: 作业描述
2651
+ # @param JobDescription: 作业描述;字符串长度限制200.
2645
2652
  # @type JobDescription: String
2646
- # @param Priority: 作业优先级,任务(Task)和任务实例(TaskInstance)会继承作业优先级
2653
+ # @param Priority: 作业优先级,任务(Task)和任务实例(TaskInstance)会继承作业优先级;范围0~100,数值越大,优先级越高。
2647
2654
  # @type Priority: Integer
2648
2655
  # @param Dependences: 依赖信息
2649
2656
  # @type Dependences: Array
@@ -2720,19 +2727,27 @@ module TencentCloud
2720
2727
 
2721
2728
  # 作业信息
2722
2729
  class JobView < TencentCloud::Common::AbstractModel
2723
- # @param JobId: 作业ID
2730
+ # @param JobId: 作业ID;JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)
2724
2731
  # @type JobId: String
2725
2732
  # @param JobName: 作业名称
2726
2733
  # @type JobName: String
2727
- # @param JobState: 作业状态
2734
+ # @param JobState: 作业状态:
2735
+ # - SUBMITTED:已提交;
2736
+ # - PENDING:等待中;
2737
+ # - RUNNABLE:可运行;
2738
+ # - STARTING:启动中;
2739
+ # - RUNNING:运行中;
2740
+ # - SUCCEED:成功;
2741
+ # - FAILED:失败;
2742
+ # - FAILED_INTERRUPTED:失败后保留实例。
2728
2743
  # @type JobState: String
2729
2744
  # @param Priority: 作业优先级
2730
2745
  # @type Priority: Integer
2731
2746
  # @param Placement: 位置信息
2732
2747
  # @type Placement: :class:`Tencentcloud::Batch.v20170312.models.Placement`
2733
- # @param CreateTime: 创建时间
2748
+ # @param CreateTime: 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
2734
2749
  # @type CreateTime: String
2735
- # @param EndTime: 结束时间
2750
+ # @param EndTime: 结束时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
2736
2751
  # @type EndTime: String
2737
2752
  # @param TaskMetrics: 任务统计指标
2738
2753
  # @type TaskMetrics: :class:`Tencentcloud::Batch.v20170312.models.TaskMetrics`
@@ -2838,9 +2853,9 @@ module TencentCloud
2838
2853
 
2839
2854
  # ModifyComputeEnv请求参数结构体
2840
2855
  class ModifyComputeEnvRequest < TencentCloud::Common::AbstractModel
2841
- # @param EnvId: 计算环境ID
2856
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
2842
2857
  # @type EnvId: String
2843
- # @param DesiredComputeNodeCount: 计算节点期望个数
2858
+ # @param DesiredComputeNodeCount: 计算节点期望个数,最大上限2000。
2844
2859
  # @type DesiredComputeNodeCount: Integer
2845
2860
  # @param EnvName: 计算环境名称
2846
2861
  # @type EnvName: String
@@ -2889,11 +2904,11 @@ module TencentCloud
2889
2904
 
2890
2905
  # ModifyTaskTemplate请求参数结构体
2891
2906
  class ModifyTaskTemplateRequest < TencentCloud::Common::AbstractModel
2892
- # @param TaskTemplateId: 任务模板ID
2907
+ # @param TaskTemplateId: 任务模板ID; 详见[任务模版](https://cloud.tencent.com/document/product/599/15902)。
2893
2908
  # @type TaskTemplateId: String
2894
- # @param TaskTemplateName: 任务模板名称
2909
+ # @param TaskTemplateName: 任务模板名称;字节长度限制60。
2895
2910
  # @type TaskTemplateName: String
2896
- # @param TaskTemplateDescription: 任务模板描述
2911
+ # @param TaskTemplateDescription: 任务模板描述;字节长度限制200。
2897
2912
  # @type TaskTemplateDescription: String
2898
2913
  # @param TaskTemplateInfo: 任务模板信息
2899
2914
  # @type TaskTemplateInfo: :class:`Tencentcloud::Batch.v20170312.models.Task`
@@ -2958,11 +2973,13 @@ module TencentCloud
2958
2973
  class NamedComputeEnv < TencentCloud::Common::AbstractModel
2959
2974
  # @param EnvName: 计算环境名称
2960
2975
  # @type EnvName: String
2961
- # @param DesiredComputeNodeCount: 计算节点期望个数
2976
+ # @param DesiredComputeNodeCount: 计算节点期望个数,最大上限2000.
2962
2977
  # @type DesiredComputeNodeCount: Integer
2963
2978
  # @param EnvDescription: 计算环境描述
2964
2979
  # @type EnvDescription: String
2965
- # @param EnvType: 计算环境管理类型
2980
+ # @param EnvType: 计算环境管理类型,枚举如下:
2981
+ # MANAGED: 由客户在Batch平台主动创建;
2982
+ # THPC_QUEUE: 由THPC平台创建,关联THPC平台的集群队列。
2966
2983
  # @type EnvType: String
2967
2984
  # @param EnvData: 计算环境具体参数
2968
2985
  # @type EnvData: :class:`Tencentcloud::Batch.v20170312.models.EnvData`
@@ -3248,7 +3265,7 @@ module TencentCloud
3248
3265
 
3249
3266
  # RetryJobs请求参数结构体
3250
3267
  class RetryJobsRequest < TencentCloud::Common::AbstractModel
3251
- # @param JobIds: 作业ID列表。
3268
+ # @param JobIds: 作业ID列表。最大重试作业数100;JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)。
3252
3269
  # @type JobIds: Array
3253
3270
 
3254
3271
  attr_accessor :JobIds
@@ -3708,7 +3725,14 @@ module TencentCloud
3708
3725
  class TaskInstanceView < TencentCloud::Common::AbstractModel
3709
3726
  # @param TaskInstanceIndex: 任务实例索引
3710
3727
  # @type TaskInstanceIndex: Integer
3711
- # @param TaskInstanceState: 任务实例状态
3728
+ # @param TaskInstanceState: 任务实例状态:
3729
+ # - PENDING:等待中;
3730
+ # - RUNNABLE:可运行;
3731
+ # - STARTING:启动中;
3732
+ # - RUNNING:运行中;
3733
+ # - SUCCEED:成功;
3734
+ # - FAILED:失败;
3735
+ # - FAILED_INTERRUPTED:失败后保留实例。
3712
3736
  # @type TaskInstanceState: String
3713
3737
  # @param ExitCode: 应用程序执行结束的exit code
3714
3738
  # @type ExitCode: Integer
@@ -3716,13 +3740,13 @@ module TencentCloud
3716
3740
  # @type StateReason: String
3717
3741
  # @param ComputeNodeInstanceId: 任务实例运行时所在计算节点(例如CVM)的InstanceId。任务实例未运行或者完结时,本字段为空。任务实例重试时,本字段会随之变化
3718
3742
  # @type ComputeNodeInstanceId: String
3719
- # @param CreateTime: 创建时间
3743
+ # @param CreateTime: 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
3720
3744
  # @type CreateTime: String
3721
- # @param LaunchTime: 启动时间
3745
+ # @param LaunchTime: 启动时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
3722
3746
  # @type LaunchTime: String
3723
- # @param RunningTime: 开始运行时间
3747
+ # @param RunningTime: 开始运行时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
3724
3748
  # @type RunningTime: String
3725
- # @param EndTime: 结束时间
3749
+ # @param EndTime: 结束时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
3726
3750
  # @type EndTime: String
3727
3751
  # @param RedirectInfo: 重定向信息
3728
3752
  # @type RedirectInfo: :class:`Tencentcloud::Batch.v20170312.models.RedirectInfo`
@@ -3858,11 +3882,18 @@ module TencentCloud
3858
3882
  class TaskView < TencentCloud::Common::AbstractModel
3859
3883
  # @param TaskName: 任务名称
3860
3884
  # @type TaskName: String
3861
- # @param TaskState: 任务状态
3885
+ # @param TaskState: 任务状态:
3886
+ # - PENDING:等待中;
3887
+ # - RUNNABLE:可运行;
3888
+ # - STARTING:启动中;
3889
+ # - RUNNING:运行中;
3890
+ # - SUCCEED:成功;
3891
+ # - FAILED:失败;
3892
+ # - FAILED_INTERRUPTED:失败后保留实例。
3862
3893
  # @type TaskState: String
3863
- # @param CreateTime: 开始时间
3894
+ # @param CreateTime: 开始时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
3864
3895
  # @type CreateTime: String
3865
- # @param EndTime: 结束时间
3896
+ # @param EndTime: 结束时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
3866
3897
  # 注意:此字段可能返回 null,表示取不到有效值。
3867
3898
  # @type EndTime: String
3868
3899
 
@@ -3885,9 +3916,9 @@ module TencentCloud
3885
3916
 
3886
3917
  # TerminateComputeNode请求参数结构体
3887
3918
  class TerminateComputeNodeRequest < TencentCloud::Common::AbstractModel
3888
- # @param EnvId: 计算环境ID
3919
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
3889
3920
  # @type EnvId: String
3890
- # @param ComputeNodeId: 计算节点ID
3921
+ # @param ComputeNodeId: 计算节点ID,节点ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
3891
3922
  # @type ComputeNodeId: String
3892
3923
 
3893
3924
  attr_accessor :EnvId, :ComputeNodeId
@@ -3921,9 +3952,9 @@ module TencentCloud
3921
3952
 
3922
3953
  # TerminateComputeNodes请求参数结构体
3923
3954
  class TerminateComputeNodesRequest < TencentCloud::Common::AbstractModel
3924
- # @param EnvId: 计算环境ID
3955
+ # @param EnvId: 计算环境ID,环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
3925
3956
  # @type EnvId: String
3926
- # @param ComputeNodeIds: 计算节点ID列表
3957
+ # @param ComputeNodeIds: 计算节点ID列表,最大数量上限100,节点ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。
3927
3958
  # @type ComputeNodeIds: Array
3928
3959
 
3929
3960
  attr_accessor :EnvId, :ComputeNodeIds
@@ -3957,7 +3988,7 @@ module TencentCloud
3957
3988
 
3958
3989
  # TerminateJob请求参数结构体
3959
3990
  class TerminateJobRequest < TencentCloud::Common::AbstractModel
3960
- # @param JobId: 作业ID
3991
+ # @param JobId: 作业ID;JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)
3961
3992
  # @type JobId: String
3962
3993
 
3963
3994
  attr_accessor :JobId
@@ -3989,9 +4020,9 @@ module TencentCloud
3989
4020
 
3990
4021
  # TerminateTaskInstance请求参数结构体
3991
4022
  class TerminateTaskInstanceRequest < TencentCloud::Common::AbstractModel
3992
- # @param JobId: 作业ID
4023
+ # @param JobId: 作业ID;详见[作业列表](https://cloud.tencent.com/document/product/599/15909)。
3993
4024
  # @type JobId: String
3994
- # @param TaskName: 任务名称
4025
+ # @param TaskName: 任务名称;详见[作业提交信息](https://cloud.tencent.com/document/product/599/15910)
3995
4026
  # @type TaskName: String
3996
4027
  # @param TaskInstanceIndex: 任务实例索引
3997
4028
  # @type TaskInstanceIndex: Integer
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-batch
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1058
4
+ version: 3.0.1059
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-05-13 00:00:00.000000000 Z
11
+ date: 2025-05-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common