Activity
计算环境的创建或销毁活动
被如下接口引用:DescribeComputeEnvActivities。
名称 | 类型 | 描述 |
---|---|---|
ActivityId | String | 活动ID |
ComputeNodeId | String | 计算节点ID |
ComputeNodeActivityType | String | 计算节点活动类型,创建或者销毁 |
EnvId | String | 计算环境ID |
Cause | String | 起因 |
ActivityState | String | 活动状态 |
StateReason | String | 状态原因 |
StartTime | String | 活动开始时间 |
EndTime | String | 活动结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceId | String | 云服务器实例ID 注意:此字段可能返回 null,表示取不到有效值。 |
AgentRunningMode
agent运行模式
被如下接口引用:CreateComputeEnv, CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Scene | String | 是 | 场景类型,支持WINDOWS |
User | String | 是 | 运行Agent的User |
Session | String | 是 | 运行Agent的Session |
AnonymousComputeEnv
计算环境
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EnvType | String | 否 | 计算环境管理类型 |
EnvData | EnvData | 否 | 计算环境具体参数 |
MountDataDisks | Array of MountDataDisk | 否 | 数据盘挂载选项 |
AgentRunningMode | AgentRunningMode | 否 | agent运行模式,适用于Windows系统 |
Application
应用程序信息
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DeliveryForm | String | 是 | 应用程序的交付方式,包括PACKAGE、LOCAL 两种取值,分别指远程存储的软件包、计算环境本地。 注意:此字段可能返回 null,表示取不到有效值。 |
Command | String | 否 | 任务执行命令。与Commands不能同时指定。 注意:此字段可能返回 null,表示取不到有效值。 |
PackagePath | String | 否 | 应用程序软件包的远程存储路径 注意:此字段可能返回 null,表示取不到有效值。 |
Docker | Docker | 否 | 应用使用Docker的相关配置。在使用Docker配置的情况下,DeliveryForm 为 LOCAL 表示直接使用Docker镜像内部的应用软件,通过Docker方式运行;DeliveryForm 为 PACKAGE,表示将远程应用包注入到Docker镜像后,通过Docker方式运行。为避免Docker不同版本的兼容性问题,Docker安装包及相关依赖由Batch统一负责,对于已安装Docker的自定义镜像,请卸载后再使用Docker特性。 注意:此字段可能返回 null,表示取不到有效值。 |
Commands | Array of CommandLine | 否 | 任务执行命令信息。与Command不能同时指定。 注意:此字段可能返回 null,表示取不到有效值。 |
Authentication
授权认证信息
被如下接口引用:CreateComputeEnv, CreateCpmComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Scene | String | 是 | 授权场景,例如COS |
SecretId | String | 是 | SecretId |
SecretKey | String | 是 | SecretKey |
CommandLine
任务执行信息描述。
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Command | String | 是 | 任务执行命令。 注意:此字段可能返回 null,表示取不到有效值。 示例值:echo hello world |
ComputeEnvCreateInfo
计算环境创建信息。
被如下接口引用:DescribeComputeEnvCreateInfos。
名称 | 类型 | 描述 |
---|---|---|
EnvId | String | 计算环境 ID |
EnvName | String | 计算环境名称 注意:此字段可能返回 null,表示取不到有效值。 |
EnvDescription | String | 计算环境描述 注意:此字段可能返回 null,表示取不到有效值。 |
EnvType | String | 计算环境类型,仅支持“MANAGED”类型 |
EnvData | EnvData | 计算环境参数 |
MountDataDisks | Array of MountDataDisk | 数据盘挂载选项 注意:此字段可能返回 null,表示取不到有效值。 |
InputMappings | Array of InputMapping | 输入映射 注意:此字段可能返回 null,表示取不到有效值。 |
Authentications | Array of Authentication | 授权信息 注意:此字段可能返回 null,表示取不到有效值。 |
Notifications | Array of Notification | 通知信息 注意:此字段可能返回 null,表示取不到有效值。 |
DesiredComputeNodeCount | Integer | 计算节点期望个数 |
Tags | Array of Tag | 计算环境标签列表 注意:此字段可能返回 null,表示取不到有效值。 |
ComputeEnvData
计算环境属性数据
被如下接口引用:ModifyComputeEnv。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
InstanceTypes | Array of String | 是 | CVM实例类型列表 |
ComputeEnvView
计算环境信息
被如下接口引用:DescribeComputeEnvs。
名称 | 类型 | 描述 |
---|---|---|
EnvId | String | 计算环境ID |
EnvName | String | 计算环境名称 |
Placement | Placement | 位置信息 |
CreateTime | String | 创建时间 |
ComputeNodeMetrics | ComputeNodeMetrics | 计算节点统计指标 |
EnvType | String | 计算环境类型 |
DesiredComputeNodeCount | Integer | 计算节点期望个数 |
ResourceType | String | 计算环境资源类型,当前为CVM和CPM(黑石) |
NextAction | String | 下一步动作 |
AttachedComputeNodeCount | Integer | 用户添加到计算环境中的计算节点个数 |
Tags | Array of Tag | 计算环境绑定的标签列表。 注意:此字段可能返回 null,表示取不到有效值。 |
ComputeNode
计算节点
被如下接口引用:DescribeComputeEnv。
名称 | 类型 | 描述 |
---|---|---|
ComputeNodeId | String | 计算节点ID |
ComputeNodeInstanceId | String | 计算节点实例ID,对于CVM场景,即为CVM的InstanceId |
ComputeNodeState | String | 计算节点状态 |
Cpu | Integer | CPU核数 |
Mem | Integer | 内存容量,单位GiB |
ResourceCreatedTime | String | 资源创建完成时间 |
TaskInstanceNumAvailable | Integer | 计算节点运行 TaskInstance 可用容量。0表示计算节点忙碌。 |
AgentVersion | String | Batch Agent 版本 |
PrivateIpAddresses | Array of String | 实例内网IP |
PublicIpAddresses | Array of String | 实例公网IP |
ResourceType | String | 计算环境资源类型,当前为CVM和CPM(黑石) |
ResourceOrigin | String | 计算环境资源来源。 BATCH_CREATED:由批量计算创建的实例资源。 USER_ATTACHED:用户添加到计算环境中的实例资源。 |
ComputeNodeMetrics
计算节点统计指标
被如下接口引用:DescribeComputeEnv, DescribeComputeEnvs。
名称 | 类型 | 描述 |
---|---|---|
SubmittedCount | Integer | 已经完成提交的计算节点数量 |
CreatingCount | Integer | 创建中的计算节点数量 |
CreationFailedCount | Integer | 创建失败的计算节点数量 |
CreatedCount | Integer | 完成创建的计算节点数量 |
RunningCount | Integer | 运行中的计算节点数量 |
DeletingCount | Integer | 销毁中的计算节点数量 |
AbnormalCount | Integer | 异常的计算节点数量 |
CpmVirtualPrivateCloud
黑石私有网络
被如下接口引用:CreateCpmComputeEnv。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
VpcId | String | 是 | 黑石私有网络ID |
SubnetId | String | 是 | 黑石子网ID |
DataDisk
描述了数据盘的信息
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DiskSize | Integer | 是 | 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,具体限制详见:存储概述。默认值为0,表示不购买数据盘。更多限制详见产品文档。 |
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 接口无效。 |
DiskId | String | 否 | 数据盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID,暂时不支持该参数。 该参数目前仅用于 DescribeInstances 等查询类接口的返回参数,不可用于RunInstances 等写接口的入参。 |
DeleteWithInstance | Boolean | 否 | 数据盘是否随子机销毁。取值范围: FALSE:子机销毁时,保留数据盘 默认取值:TRUE 该参数目前仅用于 RunInstances 接口。注意:此字段可能返回 null,表示取不到有效值。 |
SnapshotId | String | 否 | 数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。 注意:此字段可能返回 null,表示取不到有效值。 |
Encrypt | Boolean | 否 | 数据盘是加密。取值范围: false:不加密 默认取值:false 该参数目前仅用于 RunInstances 接口。注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
KmsKeyId | String | 否 | 自定义CMK对应的ID,取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 RunInstances 接口。注意:此字段可能返回 null,表示取不到有效值。 |
ThroughputPerformance | Integer | 否 | 云硬盘性能,单位:MB/s 注意:此字段可能返回 null,表示取不到有效值。 |
CdcId | String | 否 | 所属的独享集群ID。 注意:此字段可能返回 null,表示取不到有效值。 |
BurstPerformance | Boolean | 否 | 突发性能 注:内测中。 注意:此字段可能返回 null,表示取不到有效值。 |
Dependence
依赖关系
被如下接口引用:DescribeJob, DescribeJobSubmitInfo, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StartTask | String | 是 | 依赖关系的起点任务名称 |
EndTask | String | 是 | 依赖关系的终点任务名称 |
Docker
Docker容器信息
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
User | String | 是 | Docker Hub 用户名或 Tencent Registry 用户名 |
Password | String | 是 | Docker Hub 密码或 Tencent Registry 密码 |
Image | String | 是 | Docker Hub填写“[user/repo]:[tag]”,Tencent Registry填写“ccr.ccs.tencentyun.com/[namespace/repo]:[tag]” |
Server | String | 否 | Docker Hub 可以不填,但确保具有公网访问能力。或者是 Tencent Registry 服务地址“ccr.ccs.tencentyun.com” |
MaxRetryCount | Integer | 否 | 拉取Docker镜像重试次数。默认值:0。 示例值:0 |
DelayOnRetry | Integer | 否 | 拉取Docker镜像失败时延迟时间。单位:秒。 示例值:1 |
DockerRunOption | String | 否 | Docker命令运行参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:-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同时出现。 |
ImageId | String | 否 | CVM镜像ID |
SystemDisk | SystemDisk | 否 | 实例系统盘配置信息 |
DataDisks | Array of DataDisk | 否 | 实例数据盘配置信息 |
VirtualPrivateCloud | VirtualPrivateCloud | 否 | 私有网络相关信息配置,与Zones和VirtualPrivateClouds不能同时指定。 |
InternetAccessible | InternetAccessible | 否 | 公网带宽相关信息设置 |
InstanceName | String | 否 | CVM实例显示名称 |
LoginSettings | LoginSettings | 否 | 实例登录设置 |
SecurityGroupIds | Array of String | 否 | 实例所属安全组 |
EnhancedService | EnhancedService | 否 | 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。 |
InstanceChargeType | String | 否 | CVM实例计费类型 默认值:POSTPAID_BY_HOUR。 |
InstanceMarketOptions | InstanceMarketOptionsRequest | 否 | 实例的市场相关选项,如竞价实例相关参数 |
InstanceTypes | Array of String | 否 | CVM实例类型列表,不能与InstanceType和InstanceTypeOptions同时出现。指定该字段后,计算节点按照机型先后顺序依次尝试创建,直到实例创建成功,结束遍历过程。最多支持10个机型。 |
InstanceTypeOptions | InstanceTypeOptions | 否 | CVM实例机型配置。不能与InstanceType和InstanceTypes同时出现。 |
Zones | Array of String | 否 | 可用区列表,支持跨可用区创建CVM实例。与VirtualPrivateCloud和VirtualPrivateClouds不能同时指定。 |
VirtualPrivateClouds | Array of VirtualPrivateCloud | 否 | 私有网络列表,支持跨私有网络创建CVM实例。与VirtualPrivateCloud和Zones不能同时指定。 |
EnvDataCpm
黑石计算环境数据
被如下接口引用:CreateCpmComputeEnv。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Zones | Array of String | 是 | 黑石可用区名称列表。如ap-guangzhou-bls-1, 可通过黑石接口DescribeRegions接口获取。不是Batch可用区名称。目前仅支持一个可用区名称。 |
InstanceTypes | Array of String | 是 | 购买的机型ID。通过黑石接口DescribeDeviceClass查询设备型号,获取机型信息。 |
TimeUnit | String | 是 | 购买时长单位,取值:m(月)。 |
TimeSpan | Integer | 是 | 购买时长。 |
RaidId | Integer | 是 | RAID类型ID。通过黑石接口DescribeDeviceClassPartition查询机型RAID方式以及系统盘大小,获取RAID信息。 |
OsTypeId | Integer | 是 | 部署服务器的操作系统ID。通过批量计算接口DescribeCpmOsInfo查询操作系统信息。 |
VirtualPrivateClouds | Array of CpmVirtualPrivateCloud | 是 | 黑石VPC列表,目前仅支持一个VPC。 |
NeedSecurityAgent | Integer | 否 | 是否安装安全Agent,取值:1(安装) 0(不安装),默认取值0。 |
NeedMonitorAgent | Integer | 否 | 是否安装监控Agent,取值:1(安装) 0(不安装),默认取值0。 |
AutoRenewFlag | Integer | 否 | 自动续费标志位,取值:1(自动续费) 0(不自动续费),默认取值0。 |
IsZoning | Integer | 否 | 数据盘是否格式化,取值:1(格式化) 0(不格式化),默认取值为1。 |
FileSystem | String | 否 | 指定数据盘的文件系统格式,当前支持 ext4和xfs选项, 默认为ext4。 参数适用于数据盘和Linux, 且在IsZoning为1时生效。 |
Password | String | 否 | 设置Linux root或Windows Administrator的密码。若不设置此参数,默认情况下会随机生成密码,并以站内信方式通知到用户。 |
ApplyEip | Integer | 否 | 是否分配弹性公网IP,取值:1(分配) 0(不分配),默认取值0。 |
EipPayMode | String | 否 | 弹性公网IP计费模式,取值:flow(按流量计费) bandwidth(按带宽计费),默认取值flow。 |
EipBandwidth | Integer | 否 | 弹性公网IP带宽限制,单位Mb。 |
ImageId | String | 否 | 自定义镜像ID,取值生效时用自定义镜像部署物理机。 |
SysRootSpace | Integer | 否 | 系统盘根分区大小,单位为G,默认取值10G。通过黑石接口DescribeDeviceClassPartition查询机型RAID方式以及系统盘大小,获取根分区信息。 |
SysDataSpace | Integer | 否 | /data分区大小,单位为G。如果系统盘还有剩余大小,会分配给/data分区。(特殊情况:如果剩余空间不足10G,并且没有指定/data分区,则剩余空间会分配给Root分区)。 |
HyperThreading | Integer | 否 | 是否开启超线程,取值:1(开启) 0(关闭),默认取值1。 |
LanIps | Array of String | 否 | 指定的内网IP列表,不指定时自动分配。 |
EnvVar
环境变量
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 环境变量名称 |
Value | String | 是 | 环境变量取值 |
EventConfig
事件配置
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EventName | String | 是 | 事件类型,包括: |
EventVars | Array of EventVar | 是 | 自定义键值对 |
EventVar
自定义键值对
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 自定义键 |
Value | String | 是 | 自定义值 |
Externals
扩展数据
被如下接口引用:DescribeCvmZoneInstanceConfigInfos。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ReleaseAddress | Boolean | 否 | 释放地址 注意:此字段可能返回 null,表示取不到有效值。 |
UnsupportNetworks | Array of String | 否 | 不支持的网络类型,取值范围: 注意:此字段可能返回 null,表示取不到有效值。 |
StorageBlockAttr | StorageBlock | 否 | HDD本地存储属性 注意:此字段可能返回 null,表示取不到有效值。 |
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-1 &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 | 是 | 需要过滤的字段。 |
Values | Array of String | 是 | 字段的过滤值。 |
InputMapping
输入映射
被如下接口引用:CreateComputeEnv, CreateCpmComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SourcePath | String | 是 | 源端路径 |
DestinationPath | String | 是 | 目的端路径 |
MountOptionParameter | String | 否 | 挂载配置项参数 |
Instance
描述实例的信息
被如下接口引用:AttachInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
InstanceId | String | 是 | 实例ID |
ImageId | String | 否 | 镜像ID |
LoginSettings | LoginSettings | 否 | 实例登录设置。 |
InstanceCategoryItem
实例分类列表
被如下接口引用:DescribeInstanceCategories。
名称 | 类型 | 描述 |
---|---|---|
InstanceCategory | String | 实例类型名 |
InstanceFamilySet | Array of String | 实例族列表 |
InstanceMarketOptionsRequest
竞价请求相关选项
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SpotOptions | SpotMarketOptions | 是 | 竞价相关选项 注意:此字段可能返回 null,表示取不到有效值。 |
MarketType | String | 否 | 市场选项类型,当前只支持取值:spot 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceTypeConfig
批量计算可用的InstanceTypeConfig信息
被如下接口引用:DescribeAvailableCvmInstanceTypes。
名称 | 类型 | 描述 |
---|---|---|
Mem | Integer | 内存容量,单位:GB 。 |
Cpu | Integer | CPU核数,单位:核。 |
InstanceType | String | 实例机型。 |
Zone | String | 可用区。 |
InstanceFamily | String | 实例机型系列。 |
InstanceTypeOptions
实例机型配置。
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CPU | Integer | 是 | CPU核数。 |
Memory | Integer | 是 | 内存值,单位GB。 |
InstanceCategories | Array of String | 否 | 实例机型类别,可选参数:“ALL”、“GENERAL”、“GENERAL_2”、“GENERAL_3”、“COMPUTE”、“COMPUTE_2”和“COMPUTE_3”。默认值“ALL”。 |
InstanceTypeQuotaItem
描述实例机型配额信息。
被如下接口引用:DescribeCvmZoneInstanceConfigInfos。
名称 | 类型 | 描述 |
---|---|---|
Zone | String | 可用区。 |
InstanceType | String | 实例机型。 |
InstanceChargeType | String | 实例计费模式。取值范围: 专用宿主机 计费,不对专用宿主机 上的实例计费。SPOTPAID :表示竞价实例付费。 |
NetworkCard | Integer | 网卡类型,例如:25代表25G网卡 |
Externals | Externals | 扩展属性。 注意:此字段可能返回 null,表示取不到有效值。 |
Cpu | Integer | 实例的CPU核数,单位:核。 |
Memory | Integer | 实例内存容量,单位:GB 。 |
InstanceFamily | String | 实例机型系列。 |
TypeName | String | 机型名称。 |
LocalDiskTypeList | Array of LocalDiskType | 本地磁盘规格列表。当该参数返回为空值时,表示当前情况下无法创建本地盘。 |
Status | String | 实例是否售卖。取值范围: |
Price | ItemPrice | 实例的售卖价格。 |
SoldOutReason | String | 售罄原因。 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceBandwidth | Float | 内网带宽,单位Gbps。 |
InstancePps | Integer | 网络收发包能力,单位万PPS。 |
StorageBlockAmount | Integer | 本地存储块数量。 |
CpuType | String | 处理器型号。 |
Gpu | Integer | 实例的GPU数量。 |
Fpga | Integer | 实例的FPGA数量。 |
Remark | String | 实例备注信息。 |
GpuCount | Float | 实例机型映射的物理GPU卡数,单位:卡。vGPU卡型小于1,直通卡型大于等于1。vGPU是通过分片虚拟化技术,将物理GPU卡重新划分,同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。 |
Frequency | String | 实例的CPU主频信息 |
StatusCategory | String | 描述库存情况。取值范围: 注意:此字段可能返回 null,表示取不到有效值。 |
InternetAccessible
描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
InternetChargeType | String | 否 | 网络计费类型。取值范围: |
InternetMaxBandwidthOut | Integer | 否 | 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽。 |
PublicIpAssigned | Boolean | 否 | 是否分配公网IP。取值范围: 当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。 示例值:false |
BandwidthPackageId | String | 否 | 带宽包ID。可通过DescribeBandwidthPackages 接口返回值中的BandwidthPackageId 获取。该参数仅在RunInstances接口中作为入参使用。 |
ItemPrice
描述了单项的价格信息
被如下接口引用:DescribeCvmZoneInstanceConfigInfos。
名称 | 类型 | 描述 |
---|---|---|
UnitPrice | Float | 后续合计费用的原价,后付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
ChargeUnit | String | 后续计价单元,后付费模式使用,可取值范围: 注意:此字段可能返回 null,表示取不到有效值。 示例值:HOUR |
OriginalPrice | Float | 预支合计费用的原价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
DiscountPrice | Float | 预支合计费用的折扣价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
Discount | Float | 折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。 示例值:20.0 |
UnitPriceDiscount | Float | 后续合计费用的折扣价,后付费模式使用,单位:元 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
UnitPriceSecondStep | Float | 使用时间区间在(96, 360)小时的后续合计费用的原价,后付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
UnitPriceDiscountSecondStep | Float | 使用时间区间在(96, 360)小时的后续合计费用的折扣价,后付费模式使用,单位:元 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
UnitPriceThirdStep | Float | 使用时间区间在(360, ∞)小时的后续合计费用的原价,后付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
UnitPriceDiscountThirdStep | Float | 使用时间区间在(360, ∞)小时的后续合计费用的折扣价,后付费模式使用,单位:元 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
OriginalPriceThreeYear | Float | 预支三年合计费用的原价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
DiscountPriceThreeYear | Float | 预支三年合计费用的折扣价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
DiscountThreeYear | Float | 预支三年应用的折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
OriginalPriceFiveYear | Float | 预支五年合计费用的原价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
DiscountPriceFiveYear | Float | 预支五年合计费用的折扣价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
DiscountFiveYear | Float | 预支五年应用的折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
OriginalPriceOneYear | Float | 预支一年合计费用的原价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
DiscountPriceOneYear | Float | 预支一年合计费用的折扣价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
DiscountOneYear | Float | 预支一年应用的折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:20.0 |
Job
作业
被如下接口引用:SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Tasks | Array of Task | 是 | 任务信息 |
JobName | String | 否 | 作业名称 示例值:test-job |
JobDescription | String | 否 | 作业描述 示例值:test-job |
Priority | Integer | 否 | 作业优先级,任务(Task)和任务实例(TaskInstance)会继承作业优先级 示例值: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 |
JobName | String | 作业名称 |
JobState | String | 作业状态 |
Priority | Integer | 作业优先级 |
Placement | Placement | 位置信息 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 创建时间 |
EndTime | String | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
TaskMetrics | TaskMetrics | 任务统计指标 |
Tags | Array of Tag | 作业绑定的标签列表。 注意:此字段可能返回 null,表示取不到有效值。 |
LocalDiskType
本地磁盘规格
被如下接口引用:DescribeCvmZoneInstanceConfigInfos。
名称 | 类型 | 描述 |
---|---|---|
Type | String | 本地磁盘类型。 |
PartitionType | String | 本地磁盘属性。 |
MinSize | Integer | 本地磁盘最小值。 |
MaxSize | Integer | 本地磁盘最大值。 |
Required | String | 购买时本地盘是否为必选。取值范围: |
LoginSettings
描述了实例登录相关配置与信息。
被如下接口引用:AttachInstances, CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Password | String | 否 | 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? \/ ]中的特殊符号。<br><li>Windows实例密码必须12到16位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。 |
KeyIds | Array of String | 否 | 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。 |
KeepImageLogin | String | 否 | 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围: 默认取值:FALSE。 |
MountDataDisk
数据盘挂载选项
被如下接口引用:CreateComputeEnv, CreateTaskTemplate, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
LocalPath | String | 是 | 挂载点,Linux系统合法路径,或Windows系统盘符,比如"H:\" |
FileSystemType | String | 否 | 文件系统类型,Linux系统下支持"EXT3"和"EXT4"两种,默认"EXT3";Windows系统下仅支持"NTFS" |
NamedComputeEnv
计算环境
被如下接口引用:CreateComputeEnv。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EnvName | String | 是 | 计算环境名称 示例值:test-env |
DesiredComputeNodeCount | Integer | 是 | 计算节点期望个数 示例值:1 |
EnvDescription | String | 否 | 计算环境描述 示例值:test-env |
EnvType | String | 否 | 计算环境管理类型 示例值: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 |
NamedCpmComputeEnv
黑石计算环境
被如下接口引用:CreateCpmComputeEnv。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EnvName | String | 是 | 计算环境名称 示例值:test-env |
EnvData | EnvDataCpm | 是 | 计算环境具体参数 |
DesiredComputeNodeCount | Integer | 是 | 计算节点期望个数 示例值:1 |
EnvDescription | String | 否 | 计算环境描述 示例值:test-env |
EnvType | String | 否 | 计算环境管理类型, 取值MANAGED。 示例值:MANAGED |
Authentications | Array of Authentication | 否 | 授权信息 |
InputMappings | Array of InputMapping | 否 | 输入映射信息 |
Notifications | 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, CreateCpmComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TopicName | String | 是 | CMQ主题名字,要求主题名有效且关联订阅 |
EventConfigs | Array of EventConfig | 是 | 事件配置 |
OsInfo
操作系统类型
被如下接口引用:DescribeCpmOsInfo。
名称 | 类型 | 描述 |
---|---|---|
OsTypeId | Integer | 操作系统ID。 |
OsName | String | 操作系统名称。 |
OsDescription | String | 操作系统名称描述。 |
OsEnglishDescription | String | 操作系统英文名称。 |
OsClass | String | 操作系统的分类,如CentOs Debian。 |
ImageTag | String | 标识镜像分类。public:公共镜像; private: 专属镜像。 |
MaxPartitionSize | Integer | 操作系统,ext4文件下所支持的最大的磁盘大小。单位为T。 |
OutputMapping
输出映射
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SourcePath | String | 是 | 源端路径 |
DestinationPath | String | 是 | 目的端路径 |
OutputMappingOption | OutputMappingOption | 否 | 输出映射选项 注意:此字段可能返回 null,表示取不到有效值。 |
OutputMappingConfig
输出映射配置
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Scene | String | 是 | 存储类型,仅支持COS |
WorkerNum | Integer | 是 | 并行worker数量 |
WorkerPartSize | Integer | 是 | worker分块大小,单位MB |
OutputMappingOption
输出映射选项
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Workspace | String | 否 | 容器场景下,输出选项从实例映射到容器内的实例侧的工作空间。 BATCH_WORKSPACE: 工作空间为BATCH在实例内定义的工作空间,BATCH侧保证作业之间的隔离。(默认) GLOBAL_WORKSPACE: 工作空间为实例操作系统空间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:BATCH_WORKSPACE |
Placement
描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机(仅专用宿主机产品可用),母机IP等
被如下接口引用:CreateComputeEnv, CreateCpmComputeEnv, DescribeComputeEnv, DescribeComputeEnvs, DescribeJobs, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Zone | String | 是 | 实例所属的可用区名称。该参数可以通过调用 DescribeZones 的返回值中的Zone字段来获取。 |
ProjectId | Integer | 否 | 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。 |
HostIds | Array of String | 否 | 实例所属的专用宿主机ID列表,仅用于入参。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。 示例值:["host-o5i742go"] |
HostId | String | 否 | 实例所属的专用宿主机ID,仅用于出参。 示例值:host-o5i742go |
RedirectInfo
重定向信息
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, DescribeTask, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StdoutRedirectPath | String | 否 | 标准输出重定向路径 |
StderrRedirectPath | String | 否 | 标准错误重定向路径 |
StdoutRedirectFileName | String | 否 | 标准输出重定向文件名,支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} |
StderrRedirectFileName | String | 否 | 标准错误重定向文件名,支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} |
RedirectLocalInfo
本地重定向信息
被如下接口引用:CreateTaskTemplate, DescribeJobSubmitInfo, ModifyTaskTemplate, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StdoutLocalPath | String | 否 | 标准输出重定向本地路径 |
StderrLocalPath | String | 否 | 标准错误重定向本地路径 |
StdoutLocalFileName | String | 否 | 标准输出重定向本地文件名,支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} |
StderrLocalFileName | String | 否 | 标准错误重定向本地文件名,支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX} |
RunAutomationServiceEnabled
描述了 “云自动化助手” 服务相关的信息
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Enabled | Boolean | 否 | 是否开启云自动化助手。取值范围: 默认取值:false。 示例值:true |
RunMonitorServiceEnabled
描述了 “云监控” 服务相关的信息
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Enabled | Boolean | 否 | 是否开启云监控服务。取值范围: 默认取值:true。 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
RunSecurityServiceEnabled
描述了 “云安全” 服务相关的信息
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Enabled | Boolean | 否 | 是否开启云安全服务。取值范围: 默认取值:true。 示例值:false |
SpotMarketOptions
竞价相关选项
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
MaxPrice | String | 是 | 竞价出价 注意:此字段可能返回 null,表示取不到有效值。 |
SpotInstanceType | String | 否 | 竞价请求类型,当前仅支持类型:one-time 注意:此字段可能返回 null,表示取不到有效值。 |
StorageBlock
HDD的本地存储信息
被如下接口引用:DescribeCvmZoneInstanceConfigInfos。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Type | String | 否 | HDD本地存储类型,值为:LOCAL_PRO. 注意:此字段可能返回 null,表示取不到有效值。 |
MinSize | Integer | 否 | HDD本地存储的最小容量 注意:此字段可能返回 null,表示取不到有效值。 |
MaxSize | Integer | 否 | HDD本地存储的最大容量 注意:此字段可能返回 null,表示取不到有效值。 |
SystemDisk
描述了操作系统所在块设备即系统盘的信息
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DiskType | String | 否 | 系统盘类型。系统盘类型限制详见存储概述。取值范围: 默认取值:当前有库存的硬盘类型。 |
DiskId | String | 否 | 系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。 该参数目前仅用于 DescribeInstances 等查询类接口的返回参数,不可用于RunInstances 等写接口的入参。 |
DiskSize | Integer | 否 | 系统盘大小,单位:GB。默认值为 50 |
CdcId | String | 否 | 所属的独享集群ID。 注意:此字段可能返回 null,表示取不到有效值。 |
Tag
标签。
被如下接口引用:CreateComputeEnv, CreateCpmComputeEnv, CreateTaskTemplate, DescribeComputeEnv, DescribeComputeEnvCreateInfo, DescribeComputeEnvCreateInfos, DescribeComputeEnvs, DescribeJob, DescribeJobSubmitInfo, DescribeJobs, DescribeTaskTemplates, SubmitJob。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | 标签键。 注意:此字段可能返回 null,表示取不到有效值。 |
Value | String | 是 | 标签值。 注意:此字段可能返回 null,表示取不到有效值。 |
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 | 任务实例 |
StdoutLog | String | 标准输出日志(Base64编码,解码后最大日志长度2048字节) 注意:此字段可能返回 null,表示取不到有效值。 |
StderrLog | String | 标准错误日志(Base64编码,解码后最大日志长度2048字节) 注意:此字段可能返回 null,表示取不到有效值。 |
StdoutRedirectPath | String | 标准输出重定向路径 注意:此字段可能返回 null,表示取不到有效值。 |
StderrRedirectPath | String | 标准错误重定向路径 注意:此字段可能返回 null,表示取不到有效值。 |
StdoutRedirectFileName | String | 标准输出重定向文件名 注意:此字段可能返回 null,表示取不到有效值。 |
StderrRedirectFileName | String | 标准错误重定向文件名 注意:此字段可能返回 null,表示取不到有效值。 |
TaskInstanceMetrics
任务实例统计指标
被如下接口引用:DescribeJob, DescribeTask。
名称 | 类型 | 描述 |
---|---|---|
SubmittedCount | Integer | Submitted个数 |
PendingCount | Integer | Pending个数 |
RunnableCount | Integer | Runnable个数 |
StartingCount | Integer | Starting个数 |
RunningCount | Integer | Running个数 |
SucceedCount | Integer | Succeed个数 |
FailedInterruptedCount | Integer | FailedInterrupted个数 |
FailedCount | Integer | Failed个数 |
TaskInstanceView
任务实例视图信息
被如下接口引用:DescribeTask。
名称 | 类型 | 描述 |
---|---|---|
TaskInstanceIndex | Integer | 任务实例索引 |
TaskInstanceState | String | 任务实例状态 |
ExitCode | Integer | 应用程序执行结束的exit code 注意:此字段可能返回 null,表示取不到有效值。 |
StateReason | String | 任务实例状态原因,任务实例失败时,会记录失败原因 |
ComputeNodeInstanceId | String | 任务实例运行时所在计算节点(例如CVM)的InstanceId。任务实例未运行或者完结时,本字段为空。任务实例重试时,本字段会随之变化 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 创建时间 |
LaunchTime | String | 启动时间 注意:此字段可能返回 null,表示取不到有效值。 |
RunningTime | String | 开始运行时间 注意:此字段可能返回 null,表示取不到有效值。 |
EndTime | String | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
RedirectInfo | RedirectInfo | 重定向信息 |
StateDetailedReason | String | 任务实例状态原因详情,任务实例失败时,会记录失败原因 |
TaskMetrics
任务统计指标
被如下接口引用:DescribeJob, DescribeJobs。
名称 | 类型 | 描述 |
---|---|---|
SubmittedCount | Integer | Submitted个数 |
PendingCount | Integer | Pending个数 |
RunnableCount | Integer | Runnable个数 |
StartingCount | Integer | Starting个数 |
RunningCount | Integer | Running个数 |
SucceedCount | Integer | Succeed个数 |
FailedInterruptedCount | Integer | FailedInterrupted个数 |
FailedCount | Integer | Failed个数 |
TaskTemplateView
任务模板信息
被如下接口引用:DescribeTaskTemplates。
名称 | 类型 | 描述 |
---|---|---|
TaskTemplateId | String | 任务模板ID |
TaskTemplateName | String | 任务模板名称 |
TaskTemplateDescription | String | 任务模板描述 |
TaskTemplateInfo | Task | 任务模板信息 |
CreateTime | String | 创建时间 |
Tags | Array of Tag | 任务模板绑定的标签列表。 注意:此字段可能返回 null,表示取不到有效值。 |
TaskView
任务视图信息
被如下接口引用:DescribeJob。
名称 | 类型 | 描述 |
---|---|---|
TaskName | String | 任务名称 |
TaskState | String | 任务状态 |
CreateTime | String | 开始时间 |
EndTime | String | 结束时间 注意:此字段可能返回 null,表示取不到有效值。 |
VirtualPrivateCloud
描述了VPC相关信息,包括子网,IP信息等
被如下接口引用:CreateComputeEnv, DescribeComputeEnvCreateInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
VpcId | String | 是 | 私有网络ID,形如vpc-xxx 。有效的VpcId可通过登录控制台查询;也可以调用接口 DescribeVpcEx ,从接口返回中的unVpcId 字段获取。若在创建子机时VpcId与SubnetId同时传入DEFAULT ,则强制使用默认vpc网络。示例值:vpc-2ij |
SubnetId | String | 是 | 私有网络子网ID,形如subnet-xxx 。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 DescribeSubnets ,从接口返回中的unSubnetId 字段获取。若在创建子机时SubnetId与VpcId同时传入DEFAULT ,则强制使用默认vpc网络。示例值:subnet-2ks |
AsVpcGateway | Boolean | 否 | 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围: 示例值:false |
PrivateIpAddresses | Array of String | 否 | 私有网络子网 IP 数组,在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。 示例值:["10.0.0.1"] |
Ipv6AddressCount | Integer | 否 | 为弹性网卡指定随机生成的 IPv6 地址数量。 示例值:1 |