批量计算数据结构

Activity

计算环境的创建或销毁活动

被如下接口引用：DescribeComputeEnvActivities。

名称	类型	描述
ActivityId	String	活动ID 示例值：act-0akw6gb6
ComputeNodeId	String	计算节点ID 示例值：node-j8ybcrsh
ComputeNodeActivityType	String	计算节点活动类型，创建或者销毁示例值：CREATE_COMPUTE_NODE
EnvId	String	计算环境ID 示例值：env-7iri4r84
Cause	String	起因示例值：CreateComputeNode node-2bwng0f2
ActivityState	String	活动状态。取值范围： SUBMITTED：已提交 PROCESSING：处理中 SUCCEED：成功 FAILED：失败示例值：SUCCEED
StateReason	String	状态原因示例值：InternalError.CallCvm:CvmAPICode
StartTime	String	活动开始时间示例值：2021-10-04T22:47:06Z
EndTime	String	活动结束时间示例值：2021-10-05T01:02:14Z
InstanceId	String	云服务器实例ID 示例值：ins-qgks4wwf

AgentRunningMode

agent运行模式

被如下接口引用：CreateComputeEnv, CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
Scene	String	是	场景类型，支持WINDOWS 示例值：WINDOWS
User	String	是	运行Agent的User 示例值：12348349197419
Session	String	是	运行Agent的Session 示例值：95af4dd1-c6cd-4294-9439-f55028895c62

AnonymousComputeEnv

计算环境

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
EnvType	String	否	计算环境管理类型示例值：MANAGED
EnvData	EnvData	否	计算环境具体参数
MountDataDisks	Array of MountDataDisk	否	数据盘挂载选项
AgentRunningMode	AgentRunningMode	否	agent运行模式，适用于Windows系统

Application

应用程序信息

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
DeliveryForm	String	是	应用程序的交付方式，包括PACKAGE、LOCAL 两种取值，分别指远程存储的软件包、计算环境本地。示例值：LOCAL
Command	String	否	松耦合任务执行命令。与Commands不能同时指定，一般使用Command字段提交任务。示例值：sleep 10
PackagePath	String	否	应用程序软件包的远程存储路径示例值：cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/demon_job.tar.gz
Docker	Docker	否	应用使用Docker的相关配置。在使用Docker配置的情况下，DeliveryForm 为 LOCAL 表示直接使用Docker镜像内部的应用软件，通过Docker方式运行；DeliveryForm 为 PACKAGE，表示将远程应用包注入到Docker镜像后，通过Docker方式运行。为避免Docker不同版本的兼容性问题，Docker安装包及相关依赖由Batch统一负责，对于已安装Docker的自定义镜像，请卸载后再使用Docker特性。
Commands	Array of CommandLine	否	紧耦合任务执行命令信息。与Command不能同时指定。Command和Commands必须指定一个。

Authentication

授权认证信息

被如下接口引用：CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
Scene	String	是	授权场景，例如COS 示例值：COS
SecretId	String	是	SecretId 示例值：AKIDUdi16HNjSuTl027Q9ThAzpuXIjNx
SecretKey	String	是	SecretKey 示例值：Udi16HNjSuTl027Q9ThAzpuXIjN

CommandLine

任务执行信息描述。

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
Command	String	是	任务执行命令。示例值：echo hello world

ComputeEnvCreateInfo

计算环境创建信息。

被如下接口引用：DescribeComputeEnvCreateInfos。

名称	类型	描述
EnvId	String	计算环境 ID 示例值：env-5o4gphir
EnvName	String	计算环境名称示例值：demo
EnvDescription	String	计算环境描述示例值：it is a first job
EnvType	String	计算环境类型，仅支持“MANAGED”类型示例值：MANAGED
EnvData	EnvData	计算环境参数
MountDataDisks	Array of MountDataDisk	数据盘挂载选项
InputMappings	Array of InputMapping	输入映射
Authentications	Array of Authentication	授权信息
Notifications	Array of Notification	通知信息
DesiredComputeNodeCount	Integer	计算节点期望个数示例值：0
Tags	Array of Tag	计算环境标签列表

ComputeEnvData

计算环境属性数据

被如下接口引用：ModifyComputeEnv。

名称	类型	必选	描述
InstanceTypes	Array of String	是	CVM实例类型列表示例值：["SA2.MEDIUM4","SA5.MEDIUM4"]

ComputeEnvView

计算环境信息

被如下接口引用：DescribeComputeEnvs。

名称	类型	描述
EnvId	String	计算环境ID 示例值：env-5o4gphir
EnvName	String	计算环境名称示例值：first_env
Placement	Placement	位置信息
CreateTime	String	创建时间示例值：2020-11-11 15:00:33
ComputeNodeMetrics	ComputeNodeMetrics	计算节点统计指标
EnvType	String	计算环境类型示例值：MANAGED
DesiredComputeNodeCount	Integer	计算节点期望个数示例值：0
ResourceType	String	计算环境资源类型，当前为CVM和CPM（黑石）示例值：CVM
NextAction	String	下一步动作示例值：DELETING
AttachedComputeNodeCount	Integer	用户添加到计算环境中的计算节点个数示例值：1
Tags	Array of Tag	计算环境绑定的标签列表。注意：此字段可能返回 null，表示取不到有效值。

ComputeNode

计算节点

被如下接口引用：DescribeComputeEnv。

名称	类型	描述
ComputeNodeId	String	计算节点ID 示例值：node-99xnkwf0
ComputeNodeInstanceId	String	计算节点实例ID，对于CVM场景，即为CVM的InstanceId 示例值：ins-mhkm3smc
ComputeNodeState	String	计算节点状态。取值范围： PENDING：表示创建中 SUBMITTED：表示已提交创建 CREATING：表示创建中 CREATED：表示创建完成 CREATION_FAILED：表示创建失败。 RUNNING：表示运行中。 ABNORMAL：表示节点异常。 DELETING：表示删除中。示例值：RUNNING
Cpu	Integer	CPU核数示例值：2
Mem	Integer	内存容量，单位GiB 示例值：4
ResourceCreatedTime	String	资源创建完成时间示例值：2022-12-20T09:11:15Z
TaskInstanceNumAvailable	Integer	计算节点运行 TaskInstance 可用容量。0表示计算节点忙碌。示例值：1
AgentVersion	String	Batch Agent 版本示例值：1.4.4
PrivateIpAddresses	Array of String	实例内网IP 示例值：172.16.18.127
PublicIpAddresses	Array of String	实例公网IP 示例值：119.1.1.1
ResourceType	String	计算环境资源类型，当前为CVM和CPM（黑石）示例值：CVM
ResourceOrigin	String	计算环境资源来源。 BATCH_CREATED：由批量计算创建的实例资源。 USER_ATTACHED：用户添加到计算环境中的实例资源。示例值：BATCH_CREATED

ComputeNodeMetrics

计算节点统计指标

被如下接口引用：DescribeComputeEnv, DescribeComputeEnvs。

名称	类型	描述
SubmittedCount	Integer	已经完成提交的计算节点数量示例值：1
CreatingCount	Integer	创建中的计算节点数量示例值：0
CreationFailedCount	Integer	创建失败的计算节点数量示例值：1
CreatedCount	Integer	完成创建的计算节点数量示例值：0
RunningCount	Integer	运行中的计算节点数量示例值：2
DeletingCount	Integer	销毁中的计算节点数量示例值：1
AbnormalCount	Integer	异常的计算节点数量示例值：1

DataDisk

描述了数据盘的信息

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
DiskSize	Integer	是	数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：存储概述。默认值为0，表示不购买数据盘。更多限制详见产品文档。示例值：50
DiskType	String	否	数据盘类型。数据盘类型限制详见存储概述。取值范围： 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`接口无效。示例值：CLOUD_SSD
DiskId	String	否	数据盘ID。该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。示例值：disk-ciezoimt
DeleteWithInstance	Boolean	否	数据盘是否随子机销毁。取值范围： true：子机销毁时，销毁数据盘，只支持按小时后付费云盘 false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。示例值：true
SnapshotId	String	否	数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。示例值：snap-6yczrj8x
Encrypt	Boolean	否	数据盘是否加密。取值范围： true：加密 false：不加密默认取值：false 该参数目前仅用于 `RunInstances` 接口。示例值：false
KmsKeyId	String	否	自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。该参数目前仅用于 `RunInstances` 接口。注意：此字段可能返回 null，表示取不到有效值。示例值：kms-abcd1234
ThroughputPerformance	Integer	否	云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）注意：此字段可能返回 null，表示取不到有效值。示例值：20
CdcId	String	否	所属的独享集群ID。注意：此字段可能返回 null，表示取不到有效值。示例值：cdc-1648zauv
BurstPerformance	Boolean	否	突发性能注：内测中。示例值：false
DiskName	String	否	磁盘名称，长度不超过128 个字符。示例值：MyDiskName

DataPointView

监控采集的数据。

被如下接口引用：DescribeJobMonitorData。

名称	类型	描述
Timestamps	Array of Integer	监控数据采集的时间示例值：[1749696420, 1749696430]
Values	Array of Float	监控指标数据; 如果涉及到多个实例的监控数据的间隙时间，取值会为null 示例值：[0.1, 0.2]

Dependence

依赖关系

被如下接口引用：DescribeJob, DescribeJobSubmitInfo, SubmitJob。

名称	类型	必选	描述
StartTask	String	是	依赖关系的起点任务名称示例值：TaskA
EndTask	String	是	依赖关系的终点任务名称示例值：TaskB

Dimension

Job资源监控查询维度

被如下接口引用：DescribeJobMonitorData。

名称	类型	必选	描述
Name	String	是	查询指标的维度名称示例值：diskname
Value	String	是	查询指标的维度值示例值：vdb

Docker

Docker容器信息

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
Image	String	是	Docker Hub填写“[user/repo]:[tag]”，Tencent Registry填写“ccr.ccs.tencentyun.com/[namespace/repo]:[tag]” 示例值：kelvin-batch-test.tencentcloudcr.com/test/kelvin-test:v1
User	String	否	Docker Hub 用户名或 Tencent Registry 用户名；公共镜像可不填写此参数。示例值：22372874874
Password	String	否	Docker Hub 密码或 Tencent Registry 密码；公共镜像可不填写此参数。示例值：yJhbGciOiJSUzI1NiIsImtpZCI6IjJEQUg6UkNMUDpSSENTOkxNQ1g6UVBHTjpFWlhGOlBYTEo6MlpSTDpYNk9NOk5NVlE6NVNPUDpHU1AzIn0.ey
Server	String	否	Docker Hub 可以不填，但确保具有公网访问能力。或者是 Tencent Registry 服务地址“ccr.ccs.tencentyun.com” 示例值：kelvin-batch-test.tencentcloudcr.com
MaxRetryCount	Integer	否	拉取Docker镜像重试次数。默认值：0。示例值：0
DelayOnRetry	Integer	否	拉取Docker镜像失败时延迟时间。单位：秒。示例值：1
DockerRunOption	String	否	Docker命令运行参数。示例值：-u root

EnhancedService

描述了实例的增强服务启用情况与其设置，如云安全，云监控等实例 Agent

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
SecurityService	RunSecurityServiceEnabled	否	开启云安全服务。若不指定该参数，则默认开启云安全服务。示例值：true
MonitorService	RunMonitorServiceEnabled	否	开启云监控服务。若不指定该参数，则默认开启云监控服务。示例值：true
AutomationService	RunAutomationServiceEnabled	否	开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。示例值：true

EnvData

计算环境数据

被如下接口引用：CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
InstanceType	String	否	CVM实例类型，不能与InstanceTypes和InstanceTypeOptions同时出现。示例值：SA5.MEDIUM2
ImageId	String	否	CVM镜像ID 示例值：img-jsdt6r36
SystemDisk	SystemDisk	否	实例系统盘配置信息
DataDisks	Array of DataDisk	否	实例数据盘配置信息
VirtualPrivateCloud	VirtualPrivateCloud	否	私有网络相关信息配置，与Zones和VirtualPrivateClouds不能同时指定。
InternetAccessible	InternetAccessible	否	公网带宽相关信息设置
InstanceName	String	否	CVM实例显示名称示例值：demo
LoginSettings	LoginSettings	否	实例登录设置
SecurityGroupIds	Array of String	否	实例所属安全组示例值：["sg-dec9tgiy"]
EnhancedService	EnhancedService	否	增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。
InstanceChargeType	String	否	CVM实例计费类型 POSTPAID_BY_HOUR：按小时后付费 SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。示例值：POSTPAID_BY_HOUR
InstanceMarketOptions	InstanceMarketOptionsRequest	否	实例的市场相关选项，如竞价实例相关参数
InstanceTypes	Array of String	否	CVM实例类型列表，不能与InstanceType和InstanceTypeOptions同时出现。指定该字段后，计算节点按照机型先后顺序依次尝试创建，直到实例创建成功，结束遍历过程。最多支持10个机型。示例值：["SA5.MEDIUM2"]
InstanceTypeOptions	InstanceTypeOptions	否	CVM实例机型配置。不能与InstanceType和InstanceTypes同时出现。
Zones	Array of String	否	可用区列表，支持跨可用区创建CVM实例。与VirtualPrivateCloud和VirtualPrivateClouds不能同时指定。示例值：["ap-guangzhou-2"]
VirtualPrivateClouds	Array of VirtualPrivateCloud	否	私有网络列表，支持跨私有网络创建CVM实例。与VirtualPrivateCloud和Zones不能同时指定。

EnvVar

环境变量

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
Name	String	是	环境变量名称示例值：batch_demo
Value	String	是	环境变量取值示例值：first_demo

EventConfig

事件配置

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo, SubmitJob。

名称	类型	必选	描述
EventName	String	是	事件类型，包括： “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"。示例值：JOB_RUNNING
EventVars	Array of EventVar	是	自定义键值对

EventVar

自定义键值对

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo, SubmitJob。

名称	类型	必选	描述
Name	String	是	自定义键示例值：batch_demo
Value	String	是	自定义值示例值：first-demo

Externals

扩展数据

被如下接口引用：DescribeCvmZoneInstanceConfigInfos。

名称	类型	必选	描述
ReleaseAddress	Boolean	否	释放地址示例值：true
UnsupportNetworks	Array of String	否	不支持的网络类型，取值范围： BASIC：基础网络 VPC1.0：私有网络VPC1.0 示例值：VPC1.0
StorageBlockAttr	StorageBlock	否	HDD本地存储属性

Filter

描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等

若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。

若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

以DescribeInstances接口的Filter为例。若我们需要查询可用区（zone）为广州六区并且实例计费模式（instance-charge-type）为包年包月或者按量计费的实例时，可如下实现：
Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-6
&Filters.1.Name=instance-charge-type
&Filters.1.Values.0=PREPAID
&Filters.1.Values.1=POSTPAID_BY_HOUR

被如下接口引用：DescribeAvailableCvmInstanceTypes, DescribeComputeEnvActivities, DescribeComputeEnvCreateInfos, DescribeComputeEnvs, DescribeCvmZoneInstanceConfigInfos, DescribeJobs, DescribeTask, DescribeTaskTemplates。

名称	类型	必选	描述
Name	String	是	需要过滤的字段。示例值：zone
Values	Array of String	是	字段的过滤值。示例值：["ap-guangzhou-6"]

InputMapping

输入映射

被如下接口引用：CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
SourcePath	String	是	源端路径示例值：cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/
DestinationPath	String	是	目的端路径示例值：/home/input/
MountOptionParameter	String	否	挂载配置项参数示例值：-odbglevel=info
MountType	String	否	挂载COS存储时支持的挂载工具；当前可选值：COSFS、GooseFS-Lite。示例值：COSFS

Instance

描述实例的信息

被如下接口引用：AttachInstances。

名称	类型	必选	描述
InstanceId	String	是	实例ID，可通过调用接口DescribeInstances获取。示例值：ins-makv4qr2
ImageId	String	否	镜像ID，可通过调用接口DescribeImages获取。示例值：img-fy8cew7d
LoginSettings	LoginSettings	否	实例登录设置。

InstanceCategoryItem

实例分类列表

被如下接口引用：DescribeInstanceCategories。

名称	类型	描述
InstanceCategory	String	实例类型名示例值：COMPUTE_3
InstanceFamilySet	Array of String	实例族列表示例值：["C3", "CN3"]

InstanceMarketOptionsRequest

竞价请求相关选项

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
SpotOptions	SpotMarketOptions	是	竞价相关选项示例值：0.12
MarketType	String	否	市场选项类型，当前只支持取值：spot 示例值：spot

InstanceTypeConfig

批量计算可用的InstanceTypeConfig信息

被如下接口引用：DescribeAvailableCvmInstanceTypes。

名称	类型	描述
Mem	Integer	内存容量，单位：`GB`。示例值：4
Cpu	Integer	CPU核数，单位：核。示例值：2
InstanceType	String	实例机型。示例值：S2.3XLARGE24
Zone	String	可用区。示例值：ap-guangzhou-2
InstanceFamily	String	实例机型系列。示例值：S2

InstanceTypeOptions

实例机型配置。

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
CPU	Integer	是	CPU核数。示例值：2
Memory	Integer	是	内存值，单位GB。示例值：4
InstanceCategories	Array of String	否	实例机型类别，可选参数：“ALL”、“GENERAL”、“GENERAL_2”、“GENERAL_3”、“COMPUTE”、“COMPUTE_2”和“COMPUTE_3”。默认值“ALL”。示例值：COMPUTE_2

InstanceTypeQuotaItem

描述实例机型配额信息。

被如下接口引用：DescribeCvmZoneInstanceConfigInfos。

名称	类型	描述
Zone	String	可用区。示例值：ap-guangzhou-6
InstanceType	String	实例机型。示例值：S5.LARGE4
InstanceChargeType	String	实例计费模式。取值范围： PREPAID：表示预付费，即包年包月 POSTPAID_BY_HOUR：表示后付费，即按量计费 CDHPAID：表示专用宿主机付费，即只对`专用宿主机`计费，不对`专用宿主机`上的实例计费。 SPOTPAID：表示竞价实例付费。示例值：PREPAID
NetworkCard	Integer	网卡类型，例如：25代表25G网卡示例值：25
Externals	Externals	扩展属性。
Cpu	Integer	实例的CPU核数，单位：核。示例值：4
Memory	Integer	实例内存容量，单位：`GB`。示例值：4
InstanceFamily	String	实例机型系列。示例值：S5
TypeName	String	机型名称。示例值：标准型S5
LocalDiskTypeList	Array of LocalDiskType	本地磁盘规格列表。当该参数返回为空值时，表示当前情况下无法创建本地盘。
Status	String	实例是否售卖。取值范围： SELL：表示实例可购买 SOLD_OUT：表示实例已售罄。示例值：SELL
Price	ItemPrice	实例的售卖价格。
SoldOutReason	String	售罄原因。示例值：ResourcesSoldOut.SpecifiedInstanceType
InstanceBandwidth	Float	内网带宽，单位Gbps。示例值：10.0
InstancePps	Integer	网络收发包能力，单位万PPS。示例值：80
StorageBlockAmount	Integer	本地存储块数量。示例值：10
CpuType	String	处理器型号。示例值：Intel Xeon Cascade Lake 8255C
Gpu	Integer	实例的GPU数量。示例值：1
Fpga	Integer	实例的FPGA数量。示例值：1
Remark	String	实例备注信息。示例值：搭载1 块 11176 GB SATA HDD 本地硬盘
GpuCount	Float	实例机型映射的物理GPU卡数，单位：卡。vGPU卡型小于1，直通卡型大于等于1。vGPU是通过分片虚拟化技术，将物理GPU卡重新划分，同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。示例值：1.0
Frequency	String	实例的CPU主频信息示例值：-/3.1GHz
StatusCategory	String	描述库存情况。取值范围： EnoughStock：表示对应库存非常充足 NormalStock：表示对应库存供应有保障 UnderStock：表示对应库存即将售罄 WithoutStock：表示对应库存已经售罄示例值：EnoughStock

InternetAccessible

描述了实例的主网卡公网可访问性，声明了实例的公网使用计费模式，最大带宽等

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
InternetChargeType	String	否	网络计费类型。取值范围： BANDWIDTH_PREPAID：预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。示例值：BANDWIDTH_PREPAID
InternetMaxBandwidthOut	Integer	否	公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。示例值：10
PublicIpAssigned	Boolean	否	是否分配公网IP。取值范围： true：表示分配公网IP false：表示不分配公网IP 当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。示例值：false
BandwidthPackageId	String	否	带宽包ID。可通过 DescribeBandwidthPackages 接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。示例值：bwp-h1ro
InternetServiceProvider	String	否	线路类型。各种线路类型及支持地区详情可参考：EIP 的 IP 地址类型。默认值：BGP。 BGP：常规 BGP 线路已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通注意：仅部分地域支持静态单线IP。示例值：BGP
IPv4AddressType	String	否	公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见弹性公网IP产品概述。如需为资源分配公网IPv4地址，请指定公网IPv4地址类型。此功能仅部分地区灰度开放，如需使用请提交工单咨询示例值：WanIP
IPv6AddressType	String	否	弹性公网 IPv6 类型。 EIPv6：弹性公网 IPv6。 HighQualityEIPv6：精品 IPv6。仅中国香港支持精品IPv6。如需为资源分配IPv6地址，请指定弹性公网IPv6类型。此功能仅部分地区灰度开放，如需使用请提交工单咨询示例值：EIPv6
AntiDDoSPackageId	String	否	高防包唯一ID，申请高防IP时，该字段必传。示例值：bgp-00000000

ItemPrice

描述了单项的价格信息

被如下接口引用：DescribeCvmZoneInstanceConfigInfos。

名称	类型	描述
UnitPrice	Float	后续合计费用的原价，后付费模式使用，单位：元。如返回了其他时间区间项，如UnitPriceSecondStep，则本项代表时间区间在(0, 96)小时；若未返回其他时间区间项，则本项代表全时段，即(0, ∞)小时示例值：35.5
ChargeUnit	String	后续计价单元，后付费模式使用，可取值范围： HOUR：表示计价单元是按每小时来计算。当前涉及该计价单元的场景有：实例按小时后付费（POSTPAID_BY_HOUR）、带宽按小时后付费（BANDWIDTH_POSTPAID_BY_HOUR）： GB：表示计价单元是按每GB来计算。当前涉及该计价单元的场景有：流量按小时后付费（TRAFFIC_POSTPAID_BY_HOUR）。示例值：HOUR
OriginalPrice	Float	预支合计费用的原价，预付费模式使用，单位：元。示例值：35.5
DiscountPrice	Float	预支合计费用的折扣价，预付费模式使用，单位：元。示例值：35.5
Discount	Float	折扣，如20.0代表2折。示例值：20.0
UnitPriceDiscount	Float	后续合计费用的折扣价，后付费模式使用，单位：元如返回了其他时间区间项，如UnitPriceDiscountSecondStep，则本项代表时间区间在(0, 96)小时；若未返回其他时间区间项，则本项代表全时段，即(0, ∞)小时示例值：35.5
UnitPriceSecondStep	Float	使用时间区间在(96, 360)小时的后续合计费用的原价，后付费模式使用，单位：元。示例值：35.5
UnitPriceDiscountSecondStep	Float	使用时间区间在(96, 360)小时的后续合计费用的折扣价，后付费模式使用，单位：元示例值：35.5
UnitPriceThirdStep	Float	使用时间区间在(360, ∞)小时的后续合计费用的原价，后付费模式使用，单位：元。示例值：35.5
UnitPriceDiscountThirdStep	Float	使用时间区间在(360, ∞)小时的后续合计费用的折扣价，后付费模式使用，单位：元示例值：35.5
OriginalPriceThreeYear	Float	预支三年合计费用的原价，预付费模式使用，单位：元。注意：此字段可能返回 null，表示取不到有效值。示例值：35.5
DiscountPriceThreeYear	Float	预支三年合计费用的折扣价，预付费模式使用，单位：元。注意：此字段可能返回 null，表示取不到有效值。示例值：35.5
DiscountThreeYear	Float	预支三年应用的折扣，如20.0代表2折。注意：此字段可能返回 null，表示取不到有效值。示例值：35.5
OriginalPriceFiveYear	Float	预支五年合计费用的原价，预付费模式使用，单位：元。注意：此字段可能返回 null，表示取不到有效值。示例值：35.5
DiscountPriceFiveYear	Float	预支五年合计费用的折扣价，预付费模式使用，单位：元。注意：此字段可能返回 null，表示取不到有效值。示例值：35.5
DiscountFiveYear	Float	预支五年应用的折扣，如20.0代表2折。注意：此字段可能返回 null，表示取不到有效值。示例值：35.5
OriginalPriceOneYear	Float	预支一年合计费用的原价，预付费模式使用，单位：元。注意：此字段可能返回 null，表示取不到有效值。示例值：35.5
DiscountPriceOneYear	Float	预支一年合计费用的折扣价，预付费模式使用，单位：元。注意：此字段可能返回 null，表示取不到有效值。示例值：35.5
DiscountOneYear	Float	预支一年应用的折扣，如20.0代表2折。注意：此字段可能返回 null，表示取不到有效值。示例值：20.0

Job

作业

被如下接口引用：SubmitJob。

名称	类型	必选	描述
Tasks	Array of Task	是	任务信息
JobName	String	否	作业名称; 字符串长度限制60. 示例值：test-job
JobDescription	String	否	作业描述；字符串长度限制200. 示例值：test-job
Priority	Integer	否	作业优先级，任务（Task）和任务实例（TaskInstance）会继承作业优先级；范围0～100，数值越大，优先级越高。示例值：1
Dependences	Array of Dependence	否	依赖信息
Notifications	Array of Notification	否	通知信息
TaskExecutionDependOn	String	否	对于存在依赖关系的任务中，后序任务执行对于前序任务的依赖条件。取值范围包括 PRE_TASK_SUCCEED，PRE_TASK_AT_LEAST_PARTLY_SUCCEED，PRE_TASK_FINISHED，默认值为PRE_TASK_SUCCEED。示例值：PRE_TASK_SUCCEED
StateIfCreateCvmFailed	String	否	表示创建 CVM 失败按照何种策略处理。取值范围包括 FAILED，RUNNABLE。FAILED 表示创建 CVM 失败按照一次执行失败处理，RUNNABLE 表示创建 CVM 失败按照继续等待处理。默认值为FAILED。StateIfCreateCvmFailed对于提交的指定计算环境的作业无效。示例值：FAILED
Tags	Array of Tag	否	标签列表。通过指定该参数可以支持绑定标签到作业。每个作业最多绑定10个标签。
NotificationTarget	String	否	表示通知信息的通知目标类型。取值范围：CMQ，TDMQ_CMQ。 CMQ:表示向腾讯云CMQ发送消息。 TDMQ_CMQ：表示向腾讯云TDMQ_CMQ发送消息。默认值为CMQ。注：腾讯云计划于2022年6月前正式下线消息队列 CMQ，建议使用TDMQ_CMQ。参考文档：CMQ迁移到TDMQ_CMQ 示例值：TDMQ_CMQ

JobView

作业信息

被如下接口引用：DescribeJobs。

名称	类型	描述
JobId	String	作业ID；JobId详见作业列表示例值：job-f4llnqoz
JobName	String	作业名称示例值：job-asdnds0143100_N13_3
JobState	String	作业状态: - SUBMITTED：已提交； - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。示例值：RUNNING
Priority	Integer	作业优先级示例值：1
Placement	Placement	位置信息
CreateTime	String	创建时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ 示例值：2021-05-07T04:19:49Z
EndTime	String	结束时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ 示例值：2021-05-07T04:22:06Z
TaskMetrics	TaskMetrics	任务统计指标
Tags	Array of Tag	作业绑定的标签列表。

LocalDiskType

本地磁盘规格

被如下接口引用：DescribeCvmZoneInstanceConfigInfos。

名称	类型	描述
Type	String	本地磁盘类型。示例值：LOCAL_BASIC
PartitionType	String	本地磁盘属性。示例值：ROOT
MinSize	Integer	本地磁盘最小值。示例值：10
MaxSize	Integer	本地磁盘最大值。示例值：20
Required	String	购买时本地盘是否为必选。取值范围： REQUIRED：表示必选 OPTIONAL：表示可选。示例值：REQUIRED

LoginSettings

描述了实例登录相关配置与信息。

被如下接口引用：AttachInstances, CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
Password	String	否	实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9] 和 [( ) `~ ! @ # $ % ^ & * - + = \| { } [ ] : ; ' , . ? \/ ]中的特殊符号。</li> <br/><li>Windows实例密码必须12到16位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( )` ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。示例值：cbak231r7@#
KeyIds	Array of String	否	密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。示例值：nackdsnlanla@#!@#
KeepImageLogin	String	否	保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围： TRUE：表示保持镜像的登录设置 FALSE：表示不保持镜像的登录设置默认取值：FALSE。示例值：FALSE

MountDataDisk

数据盘挂载选项

被如下接口引用：CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
LocalPath	String	是	挂载点，Linux系统合法路径，或Windows系统盘符,比如"H:\" 示例值：/data/tmp
FileSystemType	String	否	文件系统类型，Linux系统下支持"EXT3"和"EXT4"两种，默认"EXT3"；Windows系统下仅支持"NTFS" 示例值：EXT3

NamedComputeEnv

计算环境

被如下接口引用：CreateComputeEnv。

名称	类型	必选	描述
EnvName	String	是	计算环境名称示例值：test-env
DesiredComputeNodeCount	Integer	是	计算节点期望个数，最大上限2000. 示例值：1
EnvDescription	String	否	计算环境描述示例值：test-env
EnvType	String	否	计算环境管理类型，枚举如下： MANAGED: 由客户在Batch平台主动创建； THPC_QUEUE: 由THPC平台创建，关联THPC平台的集群队列。示例值：MANAGED
EnvData	EnvData	否	计算环境具体参数
MountDataDisks	Array of MountDataDisk	否	数据盘挂载选项
Authentications	Array of Authentication	否	授权信息
InputMappings	Array of InputMapping	否	输入映射信息
AgentRunningMode	AgentRunningMode	否	agent运行模式，适用于Windows系统
Notifications	Array of Notification	否	通知信息
ActionIfComputeNodeInactive	String	否	非活跃节点处理策略，默认“RECREATE”，即对于实例创建失败或异常退还的计算节点，定期重新创建实例资源。示例值：RECREATE
ResourceMaxRetryCount	Integer	否	对于实例创建失败或异常退还的计算节点，定期重新创建实例资源的最大重试次数，最大值100，如果不设置的话，系统会设置一个默认值，当前为7 示例值：1
Tags	Array of Tag	否	标签列表。通过指定该参数可以支持绑定标签到计算环境。每个计算环境最多绑定10个标签。
NotificationTarget	String	否	表示通知信息的通知目标类型。取值范围：CMQ，TDMQ_CMQ。 CMQ:表示向腾讯云CMQ发送消息。 TDMQ_CMQ：表示向腾讯云TDMQ_CMQ发送消息。默认值为CMQ。注：腾讯云计划于2022年6月前正式下线消息队列 CMQ，建议使用TDMQ_CMQ。参考文档：CMQ迁移到TDMQ_CMQ 示例值：TDMQ_CMQ

Notification

通知信息

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, SubmitJob。

名称	类型	必选	描述
TopicName	String	是	CMQ主题名字，要求主题名有效且关联订阅示例值：demo
EventConfigs	Array of EventConfig	是	事件配置

OutputMapping

输出映射

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
SourcePath	String	是	源端路径示例值：/home/output/
DestinationPath	String	是	目的端路径示例值：cos://kelvin-test-125176278734.cos.ap-nanjing.myqcloud.com/batch_test/
OutputMappingOption	OutputMappingOption	否	输出映射选项

OutputMappingConfig

输出映射配置

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
Scene	String	是	存储类型，仅支持COS 示例值：COS
WorkerNum	Integer	是	并行worker数量示例值：5
WorkerPartSize	Integer	是	worker分块大小，单位MB 示例值：100

OutputMappingOption

输出映射选项

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
Workspace	String	否	容器场景下,输出选项从实例映射到容器内的实例侧的工作空间。 BATCH_WORKSPACE: 工作空间为BATCH在实例内定义的工作空间，BATCH侧保证作业之间的隔离。（默认） GLOBAL_WORKSPACE: 工作空间为实例操作系统空间。示例值：BATCH_WORKSPACE

Placement

描述了实例的抽象位置，包括其所在的可用区，所属的项目，宿主机（仅专用宿主机产品可用），母机IP，专有预扣资源等

被如下接口引用：CreateComputeEnv, DescribeComputeEnv, DescribeComputeEnvs, DescribeJobs, SubmitJob。

名称	类型	必选	描述
Zone	String	是	实例所属的可用区名称。该参数可以通过调用 DescribeZones 的返回值中的Zone字段来获取。示例值：ap-guangzhou-4
ProjectId	Integer	否	实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 `ProjectId` 字段来获取。默认取值0，表示默认项目。示例值：0
HostIds	Array of String	否	实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 DescribeHosts 的返回值中的 `HostId` 字段来获取。示例值：["host-o5i742go"]
HostId	String	否	实例所属的专用宿主机ID，仅用于出参。示例值：host-o5i742go
DedicatedResourcePackTenancy	String	否	专有资源预扣策略。取值范围： ResourcePool：使用实例资源池进行资源预扣示例值：ResourcePool
DedicatedResourcePackIds	Array of String	否	专有预扣资源ID列表。形如：rpp-7eumgm3l。通过指定专有预扣资源创建实例时，必须同时指定匹配的DedicatedResourcePackTenancy。示例值：["rpp-7eumgm3l"]
RackId	String	否	实例所属的实例资源池机架ID，仅用于出参。示例值：3F3327994BA4C23134DDCBD7828CD4CC

RedirectInfo

重定向信息

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTask, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
StdoutRedirectPath	String	否	标准输出重定向路径; 示例值：cos://kelvin-test-1351762227.cos.ap-nanjing.myqcloud.com/batch_test/
StderrRedirectPath	String	否	标准错误重定向路径示例值：cos://kelvin-test-1351762227.cos.ap-nanjing.myqcloud.com/batch_test/
StdoutRedirectFileName	String	否	标准输出重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} 示例值：demo_stdout.log
StderrRedirectFileName	String	否	标准错误重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} 示例值：demo_stderr.log

RedirectLocalInfo

本地重定向信息

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
StdoutLocalPath	String	否	标准输出重定向本地路径示例值：/tmp/log/
StderrLocalPath	String	否	标准错误重定向本地路径示例值：/tmp/log/
StdoutLocalFileName	String	否	标准输出重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} 示例值：job-5ewdqncb-stdout.log
StderrLocalFileName	String	否	标准错误重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} 示例值：job-5ewdqncb-stderr.log

RunAutomationServiceEnabled

描述了 “云自动化助手” 服务相关的信息

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
Enabled	Boolean	否	是否开启云自动化助手。取值范围： true：表示开启云自动化助手服务 false：表示不开启云自动化助手服务默认取值：false。示例值：true

RunMonitorServiceEnabled

描述了 “云监控” 服务相关的信息

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
Enabled	Boolean	否	是否开启云监控服务。取值范围： true：表示开启云监控服务 false：表示不开启云监控服务默认取值：true。示例值：true

RunSecurityServiceEnabled

描述了 “云安全” 服务相关的信息

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
Enabled	Boolean	否	是否开启云安全服务。取值范围： true：表示开启云安全服务 false：表示不开启云安全服务默认取值：true。示例值：false

SpotMarketOptions

竞价相关选项

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
MaxPrice	String	是	竞价出价示例值：0.01
SpotInstanceType	String	否	竞价请求类型，当前仅支持类型：one-time 示例值：one-time

StorageBlock

HDD的本地存储信息

被如下接口引用：DescribeCvmZoneInstanceConfigInfos。

名称	类型	必选	描述
Type	String	否	HDD本地存储类型，值为：LOCAL_PRO. 示例值：LOCAL_PRO
MinSize	Integer	否	HDD本地存储的最小容量。单位：GiB。示例值：100
MaxSize	Integer	否	HDD本地存储的最大容量。单位：GiB。示例值：200

SystemDisk

描述了操作系统所在块设备即系统盘的信息

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
DiskType	String	否	系统盘类型。系统盘类型限制详见存储概述。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘默认取值：当前有库存的硬盘类型。示例值：CLOUD_HSSD
DiskId	String	否	系统盘ID。该参数目前仅用于 DescribeInstances 等查询类接口的返回参数，不可用于 RunInstances 等写接口的入参。示例值：disk-xyzw1a3x
DiskSize	Integer	否	系统盘大小，单位：GiB。默认值为 50 示例值：50
CdcId	String	否	所属的独享集群ID。注意：此字段可能返回 null，表示取不到有效值。示例值：cdc-xxxxxx
DiskName	String	否	磁盘名称，长度不超过128 个字符。示例值：name
Encrypt	Boolean	否	系统盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 RunInstances 接口。当前参数灰度中。示例值：false
KmsKeyId	String	否	自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。该参数目前仅用于 RunInstances 接口。当前参数灰度中。示例值：kms-abcd1234

Tag

标签。

被如下接口引用：CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeComputeEnvs, DescribeJob, DescribeJobSubmitInfo, DescribeJobs, DescribeTaskTemplates, SubmitJob。

名称	类型	必选	描述
Key	String	是	标签键。示例值：batch_tag
Value	String	是	标签值。示例值：batch-demo

Task

任务

被如下接口引用：CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTaskTemplates, ModifyTaskTemplate, SubmitJob。

名称	类型	必选	描述
Application	Application	是	应用程序信息
TaskName	String	否	任务名称，在一个作业内部唯一示例值：test-task
TaskInstanceNum	Integer	否	任务实例运行个数，默认为1 示例值：1
ComputeEnv	AnonymousComputeEnv	否	运行环境信息，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。
EnvId	String	否	计算环境ID，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。示例值：env_238swek2
RedirectInfo	RedirectInfo	否	重定向信息
RedirectLocalInfo	RedirectLocalInfo	否	重定向本地信息
InputMappings	Array of InputMapping	否	输入映射
OutputMappings	Array of OutputMapping	否	输出映射
OutputMappingConfigs	Array of OutputMappingConfig	否	输出映射配置
EnvVars	Array of EnvVar	否	自定义环境变量
Authentications	Array of Authentication	否	授权信息
FailedAction	String	否	TaskInstance失败后处理方式，取值包括 - TERMINATE：销毁计算实例（默认）、 - INTERRUPT：中断任务，保留计算实例、 - FAST_INTERRUPT：快速中断任务，保留计算实例。示例值：TERMINATE
MaxRetryCount	Integer	否	任务失败后的最大重试次数，默认为0 示例值：0
Timeout	Integer	否	任务启动后的超时时间，单位秒，默认为86400秒示例值：86400
MaxConcurrentNum	Integer	否	任务最大并发数限制，默认没有限制。示例值：100
RestartComputeNode	Boolean	否	任务完成后，重启计算节点。适用于指定计算环境执行任务。示例值：false
ResourceMaxRetryCount	Integer	否	启动任务过程中，创建计算资源如CVM失败后的最大重试次数，默认为0。最大值100。计算资源创建重试的等待时间间隔策略设置如下： [1, 3]: 等待600 s发起重试； [4, 10]: 等待900 s发起重试； [11, 50]: 等待1800 s发起重试； [51, 100]: 等待3600 s发起重试； [a, b]表示重试次数区间，每次重试的等待时间随着重试次数的增加而递增。例如，计算资源创建重试8次的耗时为：3600 + 5900 = 6300 s 示例值：1

TaskInstanceLog

任务实例日志详情。

被如下接口引用：DescribeTaskLogs。

名称	类型	描述
TaskInstanceIndex	Integer	任务实例示例值：1
StdoutLog	String	标准输出日志（Base64编码，解码后最大日志长度2048字节）示例值：MApWTV8zMl80X2NlbnRvcwo
StderrLog	String	标准错误日志（Base64编码，解码后最大日志长度2048字节）示例值：MApWTV8zMl80X2NlbnRvcwo
StdoutRedirectPath	String	标准输出重定向路径示例值：cos://batch-test-11762227.cos.ap-shanghai.myqcloud.com/batch_test/
StderrRedirectPath	String	标准错误重定向路径示例值：cos://batch-test-11762227.cos.ap-shanghai.myqcloud.com/batch_test/
StdoutRedirectFileName	String	标准输出重定向文件名示例值：stdout.log
StderrRedirectFileName	String	标准错误重定向文件名示例值：stderr.log

TaskInstanceMetrics

任务实例统计指标

被如下接口引用：DescribeJob, DescribeTask。

名称	类型	描述
SubmittedCount	Integer	Submitted个数示例值：1
PendingCount	Integer	Pending个数示例值：1
RunnableCount	Integer	Runnable个数示例值：1
StartingCount	Integer	Starting个数示例值：1
RunningCount	Integer	Running个数示例值：1
SucceedCount	Integer	Succeed个数示例值：1
FailedInterruptedCount	Integer	FailedInterrupted个数示例值：1
FailedCount	Integer	Failed个数示例值：1

TaskInstanceView

任务实例视图信息

被如下接口引用：DescribeTask。

名称	类型	描述
TaskInstanceIndex	Integer	任务实例索引示例值：1
TaskInstanceState	String	任务实例状态: - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。示例值：RUNNING
ExitCode	Integer	应用程序执行结束的exit code 示例值：1
StateReason	String	任务实例状态原因，任务实例失败时，会记录失败原因示例值：failed
ComputeNodeInstanceId	String	任务实例运行时所在计算节点（例如CVM）的InstanceId。任务实例未运行或者完结时，本字段为空。任务实例重试时，本字段会随之变化示例值：ins-g9mp0ppm
CreateTime	String	创建时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。示例值：2018-02-07T09:29:09Z
LaunchTime	String	启动时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。示例值：2018-02-07T09:29:09Z
RunningTime	String	开始运行时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。示例值：2018-02-07T09:29:09Z
EndTime	String	结束时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。示例值：2018-02-07T09:29:09Z
RedirectInfo	RedirectInfo	重定向信息
StateDetailedReason	String	任务实例状态原因详情，任务实例失败时，会记录失败原因示例值：first heartbeat timeout

TaskMetrics

任务统计指标

被如下接口引用：DescribeJob, DescribeJobs。

名称	类型	描述
SubmittedCount	Integer	Submitted个数示例值：1
PendingCount	Integer	Pending个数示例值：1
RunnableCount	Integer	Runnable个数示例值：1
StartingCount	Integer	Starting个数示例值：1
RunningCount	Integer	Running个数示例值：1
SucceedCount	Integer	Succeed个数示例值：1
FailedInterruptedCount	Integer	FailedInterrupted个数示例值：1
FailedCount	Integer	Failed个数示例值：1

TaskTemplateView

任务模板信息

被如下接口引用：DescribeTaskTemplates。

名称	类型	描述
TaskTemplateId	String	任务模板ID 示例值：task-tmpl-0brmi1lm
TaskTemplateName	String	任务模板名称示例值：testbatch
TaskTemplateDescription	String	任务模板描述示例值：test batch is a example ,just for a demo.
TaskTemplateInfo	Task	任务模板信息
CreateTime	String	创建时间示例值：2018-03-19 15:40:06
Tags	Array of Tag	任务模板绑定的标签列表。注意：此字段可能返回 null，表示取不到有效值。

TaskView

任务视图信息

被如下接口引用：DescribeJob。

名称	类型	描述
TaskName	String	任务名称示例值：sample_name
TaskState	String	任务状态: - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。示例值：FAILED
CreateTime	String	开始时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。示例值：2018-02-07T09:29:09Z
EndTime	String	结束时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。示例值：2018-02-07T09:29:09Z

VirtualPrivateCloud

描述了主网卡VPC相关信息，包括子网，IP信息等

被如下接口引用：CreateComputeEnv, DescribeComputeEnvCreateInfo。

名称	类型	必选	描述
VpcId	String	是	私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录控制台查询；也可以调用接口 DescribeVpcs ，从接口返回中的`VpcId`字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。示例值：vpc-2ij
SubnetId	String	是	私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 DescribeSubnets ，从接口返回中的`SubnetId`字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。示例值：subnet-2ks
AsVpcGateway	Boolean	否	是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围： true：表示用作公网网关 false：表示不作为公网网关默认取值：false。示例值：false
PrivateIpAddresses	Array of String	否	私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。示例值：["10.0.0.1"]
Ipv6AddressCount	Integer	否	为弹性网卡指定随机生成的 IPv6 地址数量。示例值：1

数据结构

本页目录：

Activity

AgentRunningMode

AnonymousComputeEnv

Application

Authentication

CommandLine

ComputeEnvCreateInfo

ComputeEnvData

ComputeEnvView

ComputeNode

ComputeNodeMetrics

DataDisk

DataPointView

Dependence

Dimension

Docker

EnhancedService

EnvData

EnvVar

EventConfig

EventVar

Externals

Filter

InputMapping

Instance

InstanceCategoryItem

InstanceMarketOptionsRequest

InstanceTypeConfig

InstanceTypeOptions

InstanceTypeQuotaItem

InternetAccessible

ItemPrice

Job

JobView

LocalDiskType

LoginSettings

MountDataDisk

NamedComputeEnv

Notification

OutputMapping

OutputMappingConfig

OutputMappingOption

Placement

RedirectInfo

RedirectLocalInfo

RunAutomationServiceEnabled

RunMonitorServiceEnabled

RunSecurityServiceEnabled

SpotMarketOptions

StorageBlock

SystemDisk

Tag

Task

TaskInstanceLog

TaskInstanceMetrics

TaskInstanceView

TaskMetrics

TaskTemplateView

TaskView

VirtualPrivateCloud