数据结构

最近更新时间:2018-11-08 20:28:52

Activity

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

被如下接口引用:DescribeComputeEnvActivities。

名称 类型 描述
ActivityId String 活动ID
ComputeNodeId String 计算节点ID
ComputeNodeActivityType String 计算节点活动类型,创建或者销毁
EnvId String 计算环境ID
Cause String 起因
ActivityState String 活动状态
StateReason String 状态原因
StartTime String 活动开始时间
EndTime String 活动结束时间

AgentRunningMode

agent运行模式

被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

名称 类型 必选 描述
Scene String 场景类型,支持WINDOWS
User String 运行Agent的User
Session String 运行Agent的Session

AnonymousComputeEnv

计算环境

被如下接口引用:CreateTaskTemplate、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

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

Application

应用程序信息

被如下接口引用:CreateTaskTemplate、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

名称 类型 必选 描述
Command String 任务执行命令
DeliveryForm String 应用程序的交付方式,包括PACKAGE、LOCAL 两种取值,分别指远程存储的软件包、计算环境本地。
PackagePath String 应用程序软件包的远程存储路径
Docker Docker 应用使用Docker的相关配置。在使用Docker配置的情况下,DeliveryForm 为 LOCAL 表示直接使用Docker镜像内部的应用软件,通过Docker方式运行;DeliveryForm 为 PACKAGE,表示将远程应用包注入到Docker镜像后,通过Docker方式运行。为避免Docker不同版本的兼容性问题,Docker安装包及相关依赖由Batch统一负责,对于已安装Docker的自定义镜像,请卸载后再使用Docker特性。

Authentication

授权认证信息

被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

名称 类型 必选 描述
Scene String 授权场景,例如COS
SecretId String SecretId
SecretKey String SecretKey

ComputeEnvCreateInfo

计算环境创建信息。

被如下接口引用:DescribeComputeEnvCreateInfos。

名称 类型 描述
EnvId String 计算环境 ID
EnvName String 计算环境名称
EnvDescription String 计算环境描述
EnvType String 计算环境类型,仅支持“MANAGED”类型
EnvData EnvData 计算环境参数
MountDataDisks Array of MountDataDisk 数据盘挂载选项
InputMappings Array of InputMapping 输入映射
Authentications Array of Authentication 授权信息
Notifications Array of Notification 通知信息
DesiredComputeNodeCount Integer 计算节点期望个数

ComputeEnvData

计算环境属性数据

被如下接口引用:ModifyComputeEnv。

名称 类型 必选 描述
InstanceTypes Array of String CVM实例类型列表

ComputeEnvView

计算环境信息

被如下接口引用:DescribeComputeEnvs。

名称 类型 描述
EnvId String 计算环境ID
EnvName String 计算环境名称
Placement Placement 位置信息
CreateTime String 创建时间
ComputeNodeMetrics ComputeNodeMetrics 计算节点统计指标
EnvType String 计算环境类型
DesiredComputeNodeCount Integer 计算节点期望个数

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

ComputeNodeMetrics

计算节点统计指标

被如下接口引用:DescribeComputeEnv、DescribeComputeEnvs。

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

DataDisk

描述了数据盘的信息

被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

名称 类型 必选 描述
DiskSize Integer 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,具体限制详见:CVM实例配置。默认值为0,表示不购买数据盘。更多限制详见产品文档。
DiskType String 数据盘类型。数据盘类型限制详见CVM实例配置。取值范围:
  • LOCAL_BASIC:本地硬盘
  • LOCAL_SSD:本地SSD硬盘
  • CLOUD_BASIC:普通云硬盘
  • CLOUD_PREMIUM:高性能云硬盘
  • CLOUD_SSD:SSD云硬盘

    默认取值:LOCAL_BASIC。

    该参数对ResizeInstanceDisk接口无效。
  • DiskId String 数据盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。
    DeleteWithInstance Boolean 数据盘是否随子机销毁。取值范围:
  • TRUE:子机销毁时,销毁数据盘
  • FALSE:子机销毁时,保留数据盘

    默认取值:TRUE

    该参数目前仅用于 RunInstances 接口。
  • Dependence

    依赖关系

    被如下接口引用:DescribeJob、DescribeJobSubmitInfo、SubmitJob。

    名称 类型 必选 描述
    StartTask String 依赖关系的起点任务名称
    EndTask String 依赖关系的终点任务名称

    Docker

    Docker容器信息

    被如下接口引用:CreateTaskTemplate、DescribeJobSubmitInfo、DescribeTaskTemplates、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”

    EnhancedService

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

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    SecurityService RunSecurityServiceEnabled 开启云安全服务。若不指定该参数,则默认开启云安全服务。
    MonitorService RunMonitorServiceEnabled 开启云监控服务。若不指定该参数,则默认开启云监控服务。

    EnvData

    计算环境数据

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

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

    EnvVar

    环境变量

    被如下接口引用:CreateTaskTemplate、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    Name String 环境变量名称
    Value String 环境变量取值

    EventConfig

    事件配置

    被如下接口引用:CreateComputeEnv、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、SubmitJob。

    名称 类型 必选 描述
    EventName String 事件类型
    EventVars Array of EventVar 自定义键值对

    EventVar

    自定义键值对

    被如下接口引用:CreateComputeEnv、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、SubmitJob。

    名称 类型 必选 描述
    Name String 自定义键
    Value String 自定义值

    Externals

    扩展数据

    被如下接口引用:DescribeCvmZoneInstanceConfigInfos。

    名称 类型 必选 描述
    ReleaseAddress Boolean 释放地址
    UnsupportNetworks Array of String 不支持的网络类型
    StorageBlockAttr StorageBlock HDD本地存储属性

    Filter

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

    • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
    • 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(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、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    SourcePath String 源端路径
    DestinationPath String 目的端路径
    MountOptionParameter String 挂载配置项参数

    InstanceMarketOptionsRequest

    竞价请求相关选项

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    MarketType String 市场选项类型,当前只支持取值:spot
    SpotOptions SpotMarketOptions 竞价相关选项

    InstanceTypeConfig

    批量计算可用的InstanceTypeConfig信息

    被如下接口引用:DescribeAvailableCvmInstanceTypes。

    名称 类型 描述
    Mem Integer 内存容量,单位:GB
    Cpu Integer CPU核数,单位:核。
    InstanceType String 实例机型。
    Zone String 可用区。
    InstanceFamily String 实例机型系列。

    InstanceTypeQuotaItem

    描述实例机型配额信息。

    被如下接口引用:DescribeCvmZoneInstanceConfigInfos。

    名称 类型 描述
    Zone String 可用区。
    InstanceType String 实例机型。
    InstanceChargeType String 实例计费模式。取值范围:
  • PREPAID:表示预付费,即包年包月
  • POSTPAID_BY_HOUR:表示后付费,即按量计费
  • CDHPAID:表示CDH付费,即只对CDH计费,不对CDH上的实例计费。
  • NetworkCard Integer 网卡类型,例如:25代表25G网卡
    Externals Externals 扩展属性。
    Cpu Integer 实例的CPU核数,单位:核。
    Memory Integer 实例内存容量,单位:GB
    InstanceFamily String 实例机型系列。
    TypeName String 机型名称。
    LocalDiskTypeList Array of LocalDiskType 本地磁盘规格列表。
    Status String 实例是否售卖。
    Price ItemPrice 实例的售卖价格。

    InternetAccessible

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

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    InternetChargeType String 网络计费类型。取值范围:
  • BANDWIDTH_PREPAID:预付费按带宽结算
  • TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费
  • BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费
  • BANDWIDTH_PACKAGE:带宽包用户
    默认取值:非带宽包用户默认与子机付费类型保持一致。
  • InternetMaxBandwidthOut Integer 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽
    PublicIpAssigned Boolean 是否分配公网IP。取值范围:
  • TRUE:表示分配公网IP
  • FALSE:表示不分配公网IP

    当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。
  • ItemPrice

    描述了单项的价格信息

    被如下接口引用:DescribeCvmZoneInstanceConfigInfos。

    名称 类型 描述
    UnitPrice Float 后续单价,单位:元。
    ChargeUnit String 后续计价单元,可取值范围:
  • HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:实例按小时后付费(POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR):
  • GB:表示计价单元是按每GB来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)。
  • OriginalPrice Float 预支费用的原价,单位:元。
    DiscountPrice Float 预支费用的折扣价,单位:元。

    Job

    作业

    被如下接口引用:SubmitJob。

    名称 类型 必选 描述
    Tasks Array of Task 任务信息
    JobName String 作业名称
    JobDescription String 作业描述
    Priority Integer 作业优先级,任务(Task)和任务实例(TaskInstance)会继承作业优先级
    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。
    StateIfCreateCvmFailed String 表示创建 CVM 失败按照何种策略处理。取值范围包括 FAILED,RUNNABLE。FAILED 表示创建 CVM 失败按照一次执行失败处理,RUNNABLE 表示创建 CVM 失败按照继续等待处理。默认值为FAILED。StateIfCreateCvmFailed对于提交的指定计算环境的作业无效。

    JobView

    作业信息

    被如下接口引用:DescribeJobs。

    名称 类型 描述
    JobId String 作业ID
    JobName String 作业名称
    JobState String 作业状态
    Priority Integer 作业优先级
    Placement Placement 位置信息
    CreateTime String 创建时间
    EndTime String 结束时间
    TaskMetrics TaskMetrics 任务统计指标

    LocalDiskType

    本地磁盘规格

    被如下接口引用:DescribeCvmZoneInstanceConfigInfos。

    名称 类型 描述
    Type String 本地磁盘类型。
    PartitionType String 本地磁盘属性。
    MinSize Integer 本地磁盘最小值。
    MaxSize Integer 本地磁盘最大值。

    LoginSettings

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

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
  • Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = &#124; { } [ ] : ; ' , . ? / ]中的特殊符号。<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。取值范围:
  • TRUE:表示保持镜像的登录设置
  • FALSE:表示不保持镜像的登录设置

    默认取值:FALSE。
  • MountDataDisk

    数据盘挂载选项

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    LocalPath String 挂载点,Linux系统合法路径,或Windows系统盘符,比如"H:\"
    FileSystemType String 文件系统类型,Linux系统下支持"EXT3"和"EXT4"两种,默认"EXT3";Windows系统下仅支持"NTFS"

    NamedComputeEnv

    计算环境

    被如下接口引用:CreateComputeEnv。

    名称 类型 必选 描述
    EnvName String 计算环境名称
    DesiredComputeNodeCount Integer 计算节点期望个数
    EnvDescription String 计算环境描述
    EnvType String 计算环境管理类型
    EnvData EnvData 计算环境具体参数
    MountDataDisks Array of MountDataDisk 数据盘挂载选项
    Authentications Array of Authentication 授权信息
    InputMappings Array of InputMapping 输入映射信息
    AgentRunningMode AgentRunningMode agent运行模式,适用于Windows系统
    Notifications Notification 通知信息
    ActionIfComputeNodeInactive String 非活跃节点处理策略,默认“RECREATE”,即对于实例创建失败或异常退还的计算节点,定期重新创建实例资源。

    Notification

    通知信息

    被如下接口引用:CreateComputeEnv、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、SubmitJob。

    名称 类型 必选 描述
    TopicName String CMQ主题名字,要求主题名有效且关联订阅
    EventConfigs Array of EventConfig 事件配置

    OutputMapping

    输出映射

    被如下接口引用:CreateTaskTemplate、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    SourcePath String 源端路径
    DestinationPath String 目的端路径

    OutputMappingConfig

    输出映射配置

    被如下接口引用:CreateTaskTemplate、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    Scene String 存储类型,仅支持COS
    WorkerNum Integer 并行worker数量
    WorkerPartSize Integer worker分块大小

    Placement

    描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机等(仅CDH产品可用)

    被如下接口引用:CreateComputeEnv、DescribeComputeEnv、DescribeComputeEnvs、DescribeJobs、SubmitJob。

    名称 类型 必选 描述
    Zone String 实例所属的可用区ID。该参数也可以通过调用 DescribeZones 的返回值中的Zone字段来获取。
    ProjectId Integer 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
    HostIds Array of String 实例所属的专用宿主机ID列表。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。

    RedirectInfo

    重定向信息

    被如下接口引用:CreateTaskTemplate、DescribeJob、DescribeJobSubmitInfo、DescribeTask、DescribeTaskTemplates、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、DescribeTaskTemplates、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}

    RunMonitorServiceEnabled

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

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    Enabled Boolean 是否开启云监控服务。取值范围:
  • TRUE:表示开启云监控服务
  • FALSE:表示不开启云监控服务

    默认取值:TRUE。
  • RunSecurityServiceEnabled

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

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    Enabled Boolean 是否开启云安全服务。取值范围:
  • TRUE:表示开启云安全服务
  • FALSE:表示不开启云安全服务

    默认取值:TRUE。
  • SpotMarketOptions

    竞价相关选项

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    MaxPrice String 竞价出价
    SpotInstanceType String 竞价请求类型,当前仅支持类型:one-time

    StorageBlock

    HDD的本地存储信息

    被如下接口引用:DescribeCvmZoneInstanceConfigInfos。

    名称 类型 描述
    Type String HDD本地存储类型,值为:LOCAL_PRO.
    MinSize Integer HDD本地存储的最小容量
    MaxSize Integer HDD本地存储的最大容量

    SystemDisk

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

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    DiskType String 系统盘类型。系统盘类型限制详见CVM实例配置。取值范围:
  • LOCAL_BASIC:本地硬盘
  • LOCAL_SSD:本地SSD硬盘
  • CLOUD_BASIC:普通云硬盘
  • CLOUD_SSD:SSD云硬盘
  • CLOUD_PREMIUM:高性能云硬盘

    默认取值:CLOUD_BASIC。
  • DiskId String 系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。
    DiskSize Integer 系统盘大小,单位:GB。默认值为 50

    Task

    任务

    被如下接口引用:CreateTaskTemplate、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    Application Application 应用程序信息
    TaskName String 任务名称,在一个作业内部唯一
    TaskInstanceNum Integer 任务实例运行个数
    ComputeEnv AnonymousComputeEnv 运行环境信息,ComputeEnv 和 EnvId 必须指定一个(且只有一个)参数。
    EnvId String 计算环境ID,ComputeEnv 和 EnvId 必须指定一个(且只有一个)参数。
    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。
    MaxRetryCount Integer 任务失败后的最大重试次数,默认为0
    Timeout Integer 任务启动后的超时时间,单位秒,默认为86400秒

    TaskInstanceLog

    任务实例日志详情。

    被如下接口引用:DescribeTaskLogs。

    名称 类型 描述
    TaskInstanceIndex Integer 任务实例
    StdoutLog String 标准输出日志(Base64编码)
    StderrLog String 标准错误日志(Base64编码)
    StdoutRedirectPath String 标准输出重定向路径
    StderrRedirectPath String 标准错误重定向路径
    StdoutRedirectFileName String 标准输出重定向文件名
    StderrRedirectFileName String 标准错误重定向文件名

    TaskInstanceMetrics

    任务实例统计指标

    被如下接口引用: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

    任务实例视图信息

    被如下接口引用:DescribeJob、DescribeTask。

    名称 类型 描述
    TaskInstanceIndex Integer 任务实例索引
    TaskInstanceState String 任务实例状态
    ExitCode Integer 应用程序执行结束的exit code
    StateReason String 任务实例状态原因,任务实例失败时,会记录失败原因
    ComputeNodeInstanceId String 任务实例运行时所在计算节点(例如CVM)的InstanceId。任务实例未运行或者完结时,本字段为空。任务实例重试时,本字段会随之变化
    CreateTime String 创建时间
    LaunchTime String 启动时间
    RunningTime String 开始运行时间
    EndTime String 结束时间
    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 创建时间

    TaskView

    任务视图信息

    被如下接口引用:DescribeJob。

    名称 类型 描述
    TaskName String 任务名称
    TaskState String 任务状态
    CreateTime String 开始时间
    EndTime String 结束时间

    VirtualPrivateCloud

    描述了VPC相关信息,包括子网,IP信息等

    被如下接口引用:CreateComputeEnv、CreateTaskTemplate、DescribeComputeEnvCreateInfo、DescribeComputeEnvCreateInfos、DescribeJobSubmitInfo、DescribeTaskTemplates、ModifyTaskTemplate、SubmitJob。

    名称 类型 必选 描述
    VpcId String 私有网络ID,形如vpc-xxx。有效的VpcId可通过登录控制台查询;也可以调用接口 DescribeVpcEx ,从接口返回中的unVpcId字段获取。
    SubnetId String 私有网络子网ID,形如subnet-xxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 DescribeSubnets ,从接口返回中的unSubnetId字段获取。
    AsVpcGateway Boolean 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围:
  • TRUE:表示用作公网网关
  • FALSE:表示不用作公网网关

    默认取值:FALSE。
  • PrivateIpAddresses Array of String 私有网络子网 IP 数组,在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。