{ "name": "batch", "display_name": "批量计算", "description": "介绍如何使用API对批量计算服务进行操作，包括作业、任务模块、计算环境等。", "domain": "compute", "api_version": "2017-03-12", "endpoint": "batch.tencentcloudapi.com", "actions": [ { "name": "AttachInstances", "description": "此接口可将已存在实例添加到计算环境中。 实例需要满足如下条件： 1.实例不在批量计算系统中。 2.实例状态要求处于运行中。 3.支持预付费实例，按小时后付费实例，专享子机实例。不支持竞价实例。 此接口会将加入到计算环境中的实例重设UserData和重装操作系统。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取。", "example": "env-nuydksjj" }, { "name": "Instances", "type": "array", "required": true, "description": "加入计算环境实例列表，每次请求的实例的上限为100。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，可通过调用接口[DescribeInstances](https://cloud.tencent.com/document/product/213/15728)获取。", "example": "ins-makv4qr2" }, { "name": "ImageId", "type": "string", "required": false, "description": "镜像ID，可通过调用接口[DescribeImages](https://cloud.tencent.com/document/product/213/15715)获取。", "example": "img-fy8cew7d" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? \\/ ]中的特殊符号。 Windows实例密码必须12到16位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) ` ~ ! @ # $ % ^ \u0026 * - + = { } [ ] : ; ' , . ? \\/]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用\ufffd...", "example": "cbak231r7@#" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。", "example": "nackdsnlanla@#!@#", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围：TRUE：表示保持镜像的登录设置FALSE：表示不保持镜像的登录设置默认取值：FALSE。", "example": "FALSE" } ] } ] } ], "required": [ "EnvId", "Instances" ] }, { "name": "CreateComputeEnv", "description": "用于创建计算环境", "status": "online", "parameters": [ { "name": "ComputeEnv", "type": "object", "required": true, "description": "计算环境信息", "example": "无", "children": [ { "name": "EnvName", "type": "string", "required": true, "description": "计算环境名称", "example": "test-env" }, { "name": "DesiredComputeNodeCount", "type": "integer", "required": true, "description": "计算节点期望个数，最大上限2000.", "example": "1" }, { "name": "EnvDescription", "type": "string", "required": false, "description": "计算环境描述", "example": "test-env" }, { "name": "EnvType", "type": "string", "required": false, "description": "计算环境管理类型，枚举如下： MANAGED: 由客户在Batch平台主动创建； THPC_QUEUE: 由THPC平台创建，关联THPC平台的集群队列。", "example": "MANAGED" }, { "name": "EnvData", "type": "object", "required": false, "description": "计算环境具体参数", "example": "无", "children": [ { "name": "InstanceType", "type": "string", "required": false, "description": "CVM实例类型，不能与InstanceTypes和InstanceTypeOptions同时出现。", "example": "SA5.MEDIUM2" }, { "name": "ImageId", "type": "string", "required": false, "description": "CVM镜像ID", "example": "img-jsdt6r36" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD\ufffd\ufffd...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘ID。 该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。", "example": "disk-ciezoimt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。", "example": "snap-6yczrj8x" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 `RunInstances` 接口。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD） 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1648zauv" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。", "example": "false" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "MyDiskName" } ] }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置，与Zones和VirtualPrivateClouds不能同时指定。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。", "example": "BANDWIDTH_PREPAID" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。", "example": "10" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：true：表示分配公网IPfalse：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[ DescribeBandwidthPackages ](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。", "example": "bwp-h1ro" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646)。 如需为资源分配公网IPv4地址，请指定公网IPv4地址类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "WanIP" }, { "name": "IPv6AddressType", "type": "string", "required": false, "description": "弹性公网 IPv6 类型。 EIPv6：弹性公网 IPv6。 HighQualityEIPv6：精品 IPv6。仅中国香港支持精品IPv6。 如需为资源分配IPv6地址，请指定弹性公网IPv6类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "EIPv6" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" } ] }, { "name": "InstanceName", "type": "string", "required": false, "description": "CVM实例显示名称", "example": "demo" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? \\/ ]中的特殊符号。 Windows实例密码必须12到16位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) ` ~ ! @ # $ % ^ \u0026 * - + = { } [ ] : ; ' , . ? \\/]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用\ufffd...", "example": "cbak231r7@#" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。", "example": "nackdsnlanla@#!@#", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围：TRUE：表示保持镜像的登录设置FALSE：表示不保持镜像的登录设置默认取值：FALSE。", "example": "FALSE" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组", "example": "[\"sg-dec9tgiy\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "true" }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "true" }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。", "example": "true" } ] }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "CVM实例计费类型POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数", "example": "无", "children": [ { "name": "SpotOptions", "type": "object", "required": true, "description": "竞价相关选项", "example": "0.12" }, { "name": "MarketType", "type": "string", "required": false, "description": "市场选项类型，当前只支持取值：spot", "example": "spot" } ] }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "CVM实例类型列表，不能与InstanceType和InstanceTypeOptions同时出现。指定该字段后，计算节点按照机型先后顺序依次尝试创建，直到实例创建成功，结束遍历过程。最多支持10个机型。", "example": "[\"SA5.MEDIUM2\"]", "item_type": "string" }, { "name": "InstanceTypeOptions", "type": "object", "required": false, "description": "CVM实例机型配置。不能与InstanceType和InstanceTypes同时出现。", "example": "无", "children": [ { "name": "CPU", "type": "integer", "required": true, "description": "CPU核数。", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存值，单位GB。", "example": "4" }, { "name": "InstanceCategories", "type": "array", "required": false, "description": "实例机型类别，可选参数：“ALL”、“GENERAL”、“GENERAL_2”、“GENERAL_3”、“COMPUTE”、“COMPUTE_2”和“COMPUTE_3”。默认值“ALL”。", "example": "COMPUTE_2", "item_type": "string" } ] }, { "name": "Zones", "type": "array", "required": false, "description": "可用区列表，支持跨可用区创建CVM实例。与VirtualPrivateCloud和VirtualPrivateClouds不能同时指定。", "example": "[\"ap-guangzhou-2\"]", "item_type": "string" }, { "name": "VirtualPrivateClouds", "type": "array", "required": false, "description": "私有网络列表，支持跨私有网络创建CVM实例。与VirtualPrivateCloud和Zones不能同时指定。", "example": "无", "item_type": "object", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] } ] }, { "name": "MountDataDisks", "type": "array", "required": false, "description": "数据盘挂载选项", "example": "无", "item_type": "object", "children": [ { "name": "LocalPath", "type": "string", "required": true, "description": "挂载点，Linux系统合法路径，或Windows系统盘符,比如\"H:\\\\\"", "example": "/data/tmp" }, { "name": "FileSystemType", "type": "string", "required": false, "description": "文件系统类型，Linux系统下支持\"EXT3\"和\"EXT4\"两种，默认\"EXT3\"；Windows系统下仅支持\"NTFS\"", "example": "EXT3" } ] }, { "name": "Authentications", "type": "array", "required": false, "description": "授权信息", "example": "无", "item_type": "object", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "授权场景，例如COS", "example": "COS" }, { "name": "SecretId", "type": "string", "required": true, "description": "SecretId", "example": "AKIDUdi16HNjSuTl027Q9ThAzpuXIjNx" }, { "name": "SecretKey", "type": "string", "required": true, "description": "SecretKey", "example": "Udi16HNjSuTl027Q9ThAzpuXIjN" } ] }, { "name": "InputMappings", "type": "array", "required": false, "description": "输入映射信息", "example": "无", "item_type": "object", "children": [ { "name": "SourcePath", "type": "string", "required": true, "description": "源端路径", "example": "cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "DestinationPath", "type": "string", "required": true, "description": "目的端路径", "example": "/home/input/" }, { "name": "MountOptionParameter", "type": "string", "required": false, "description": "挂载配置项参数", "example": "-odbglevel=info" }, { "name": "MountType", "type": "string", "required": false, "description": "挂载COS存储时支持的挂载工具；当前可选值：COSFS、GooseFS-Lite。", "example": "COSFS" } ] }, { "name": "AgentRunningMode", "type": "object", "required": false, "description": "agent运行模式，适用于Windows系统", "example": "无", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "场景类型，支持WINDOWS", "example": "WINDOWS" }, { "name": "User", "type": "string", "required": true, "description": "运行Agent的User", "example": "12348349197419" }, { "name": "Session", "type": "string", "required": true, "description": "运行Agent的Session", "example": "95af4dd1-c6cd-4294-9439-f55028895c62" } ] }, { "name": "Notifications", "type": "array", "required": false, "description": "通知信息", "example": "无", "item_type": "object", "children": [ { "name": "TopicName", "type": "string", "required": true, "description": "CMQ主题名字，要求主题名有效且关联订阅", "example": "demo" }, { "name": "EventConfigs", "type": "array", "required": true, "description": "事件配置", "example": "无", "item_type": "object", "children": [ { "name": "EventName", "type": "string", "required": true, "description": "事件类型，包括：“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”：任务失\ufffd\ufffd...", "example": "JOB_RUNNING" }, { "name": "EventVars", "type": "array", "required": true, "description": "自定义键值对", "example": "无", "item_type": "string" } ] } ] }, { "name": "ActionIfComputeNodeInactive", "type": "string", "required": false, "description": "非活跃节点处理策略，默认“RECREATE”，即对于实例创建失败或异常退还的计算节点，定期重新创建实例资源。", "example": "RECREATE" }, { "name": "ResourceMaxRetryCount", "type": "integer", "required": false, "description": "对于实例创建失败或异常退还的计算节点，定期重新创建实例资源的最大重试次数，最大值100，如果不设置的话，系统会设置一个默认值，当前为7", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表。通过指定该参数可以支持绑定标签到计算环境。每个计算环境最多绑定10个标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键。", "example": "batch_tag" }, { "name": "Value", "type": "string", "required": true, "description": "标签值。", "example": "batch-demo" } ] }, { "name": "NotificationTarget", "type": "string", "required": false, "description": "表示通知信息的通知目标类型。 取值范围：CMQ，TDMQ_CMQ。 CMQ:表示向腾讯云CMQ发送消息。 TDMQ_CMQ：表示向腾讯云TDMQ_CMQ发送消息。默认值为CMQ。注：腾讯云计划于2022年6月前正式下线消息队列 CMQ，建议使用TDMQ_CMQ。参考文档：[CMQ迁移到TDMQ_CMQ](https://cloud.tencent.com/document/product/406/60860)", "example": "TDMQ_CMQ" } ] }, { "name": "Placement", "type": "object", "required": true, "description": "位置信息", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-4" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 `ProjectId` 字段来获取。默认取值0，表示默认项目。", "example": "0" }, { "name": "HostIds", "type": "array", "required": false, "description": "实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 的返回值中的 `HostId` 字段来获取。", "example": "[\"host-o5i742go\"]", "item_type": "string" }, { "name": "HostId", "type": "string", "required": false, "description": "实例所属的专用宿主机ID，仅用于出参。", "example": "host-o5i742go" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由用户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "19c018a8-e17b-4073-b7fb-84b56cb890f9" } ], "required": [ "ComputeEnv", "Placement" ] }, { "name": "CreateTaskTemplate", "description": "用于创建任务模板", "status": "online", "parameters": [ { "name": "TaskTemplateName", "type": "string", "required": true, "description": "任务模板名称，最大长度限制60个字符。", "example": "job1" }, { "name": "TaskTemplateInfo", "type": "object", "required": true, "description": "任务模板内容，参数要求与任务一致", "example": "无", "children": [ { "name": "Application", "type": "object", "required": true, "description": "应用程序信息", "example": "无", "children": [ { "name": "DeliveryForm", "type": "string", "required": true, "description": "应用程序的交付方式，包括PACKAGE、LOCAL 两种取值，分别指远程存储的软件包、计算环境本地。", "example": "LOCAL" }, { "name": "Command", "type": "string", "required": false, "description": "松耦合任务执行命令。与Commands不能同时指定，一般使用Command字段提交任务。", "example": "sleep 10" }, { "name": "PackagePath", "type": "string", "required": false, "description": "应用程序软件包的远程存储路径", "example": "cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/demon_job.tar.gz" }, { "name": "Docker", "type": "object", "required": false, "description": "应用使用Docker的相关配置。在使用Docker配置的情况下，DeliveryForm 为 LOCAL 表示直接使用Docker镜像内部的应用软件，通过Docker方式运行；DeliveryForm 为 PACKAGE，表示将远程应用包注入到Docker镜像后，通过Docker方式运行。为避免Docker不同版本的兼容性问题，Docker安装包及相关依赖由Batch统一负责，对于已安装Docker的自定义镜像，请卸载后再使用Docker特性。", "example": "无", "children": [ { "name": "Image", "type": "string", "required": true, "description": "Docker Hub填写“[user/repo]:[tag]”，Tencent Registry填写“ccr.ccs.tencentyun.com/[namespace/repo]:[tag]”", "example": "kelvin-batch-test.tencentcloudcr.com/test/kelvin-test:v1" }, { "name": "User", "type": "string", "required": false, "description": "Docker Hub 用户名或 Tencent Registry 用户名；公共镜像可不填写此参数。", "example": "22372874874" }, { "name": "Password", "type": "string", "required": false, "description": "Docker Hub 密码或 Tencent Registry 密码；公共镜像可不填写此参数。", "example": "yJhbGciOiJSUzI1NiIsImtpZCI6IjJEQUg6UkNMUDpSSENTOkxNQ1g6UVBHTjpFWlhGOlBYTEo6MlpSTDpYNk9NOk5NVlE6NVNPUDpHU1AzIn0.ey" }, { "name": "Server", "type": "string", "required": false, "description": "Docker Hub 可以不填，但确保具有公网访问能力。或者是 Tencent Registry 服务地址“ccr.ccs.tencentyun.com”", "example": "kelvin-batch-test.tencentcloudcr.com" }, { "name": "MaxRetryCount", "type": "integer", "required": false, "description": "拉取Docker镜像重试次数。默认值：0。", "example": "0" }, { "name": "DelayOnRetry", "type": "integer", "required": false, "description": "拉取Docker镜像失败时延迟时间。单位：秒。", "example": "1" }, { "name": "DockerRunOption", "type": "string", "required": false, "description": "Docker命令运行参数。", "example": "-u root" } ] }, { "name": "Commands", "type": "array", "required": false, "description": "紧耦合任务执行命令信息。与Command不能同时指定。Command和Commands必须指定一个。", "example": "无", "item_type": "object", "children": [ { "name": "Command", "type": "string", "required": true, "description": "任务执行命令。", "example": "echo hello world" } ] } ] }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称，在一个作业内部唯一", "example": "test-task" }, { "name": "TaskInstanceNum", "type": "integer", "required": false, "description": "任务实例运行个数，默认为1", "example": "1" }, { "name": "ComputeEnv", "type": "object", "required": false, "description": "运行环境信息，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。", "example": "无", "children": [ { "name": "EnvType", "type": "string", "required": false, "description": "计算环境管理类型", "example": "MANAGED" }, { "name": "EnvData", "type": "object", "required": false, "description": "计算环境具体参数", "example": "无", "children": [ { "name": "InstanceType", "type": "string", "required": false, "description": "CVM实例类型，不能与InstanceTypes和InstanceTypeOptions同时出现。", "example": "SA5.MEDIUM2" }, { "name": "ImageId", "type": "string", "required": false, "description": "CVM镜像ID", "example": "img-jsdt6r36" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息", "example": "无" }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息", "example": "无", "item_type": "string" }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置，与Zones和VirtualPrivateClouds不能同时指定。", "example": "无" }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置", "example": "无" }, { "name": "InstanceName", "type": "string", "required": false, "description": "CVM实例显示名称", "example": "demo" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置", "example": "无" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组", "example": "[\"sg-dec9tgiy\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。", "example": "无" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "CVM实例计费类型POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数", "example": "无" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "CVM实例类型列表，不能与InstanceType和InstanceTypeOptions同时出现。指定该字段后，计算节点按照机型先后顺序依次尝试创建，直到实例创建成功，结束遍历过程。最多支持10个机型。", "example": "[\"SA5.MEDIUM2\"]", "item_type": "string" }, { "name": "InstanceTypeOptions", "type": "object", "required": false, "description": "CVM实例机型配置。不能与InstanceType和InstanceTypes同时出现。", "example": "无" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区列表，支持跨可用区创建CVM实例。与VirtualPrivateCloud和VirtualPrivateClouds不能同时指定。", "example": "[\"ap-guangzhou-2\"]", "item_type": "string" }, { "name": "VirtualPrivateClouds", "type": "array", "required": false, "description": "私有网络列表，支持跨私有网络创建CVM实例。与VirtualPrivateCloud和Zones不能同时指定。", "example": "无", "item_type": "string" } ] }, { "name": "MountDataDisks", "type": "array", "required": false, "description": "数据盘挂载选项", "example": "无", "item_type": "object", "children": [ { "name": "LocalPath", "type": "string", "required": true, "description": "挂载点，Linux系统合法路径，或Windows系统盘符,比如\"H:\\\\\"", "example": "/data/tmp" }, { "name": "FileSystemType", "type": "string", "required": false, "description": "文件系统类型，Linux系统下支持\"EXT3\"和\"EXT4\"两种，默认\"EXT3\"；Windows系统下仅支持\"NTFS\"", "example": "EXT3" } ] }, { "name": "AgentRunningMode", "type": "object", "required": false, "description": "agent运行模式，适用于Windows系统", "example": "无", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "场景类型，支持WINDOWS", "example": "WINDOWS" }, { "name": "User", "type": "string", "required": true, "description": "运行Agent的User", "example": "12348349197419" }, { "name": "Session", "type": "string", "required": true, "description": "运行Agent的Session", "example": "95af4dd1-c6cd-4294-9439-f55028895c62" } ] } ] }, { "name": "EnvId", "type": "string", "required": false, "description": "计算环境ID，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。", "example": "env_238swek2" }, { "name": "RedirectInfo", "type": "object", "required": false, "description": "重定向信息", "example": "无", "children": [ { "name": "StdoutRedirectPath", "type": "string", "required": false, "description": "标准输出重定向路径;", "example": "cos://kelvin-test-1351762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "StderrRedirectPath", "type": "string", "required": false, "description": "标准错误重定向路径", "example": "cos://kelvin-test-1351762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "StdoutRedirectFileName", "type": "string", "required": false, "description": "标准输出重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "demo_stdout.log" }, { "name": "StderrRedirectFileName", "type": "string", "required": false, "description": "标准错误重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "demo_stderr.log" } ] }, { "name": "RedirectLocalInfo", "type": "object", "required": false, "description": "重定向本地信息", "example": "无", "children": [ { "name": "StdoutLocalPath", "type": "string", "required": false, "description": "标准输出重定向本地路径", "example": "/tmp/log/" }, { "name": "StderrLocalPath", "type": "string", "required": false, "description": "标准错误重定向本地路径", "example": "/tmp/log/" }, { "name": "StdoutLocalFileName", "type": "string", "required": false, "description": "标准输出重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "job-5ewdqncb-stdout.log" }, { "name": "StderrLocalFileName", "type": "string", "required": false, "description": "标准错误重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "job-5ewdqncb-stderr.log" } ] }, { "name": "InputMappings", "type": "array", "required": false, "description": "输入映射", "example": "无", "item_type": "object", "children": [ { "name": "SourcePath", "type": "string", "required": true, "description": "源端路径", "example": "cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "DestinationPath", "type": "string", "required": true, "description": "目的端路径", "example": "/home/input/" }, { "name": "MountOptionParameter", "type": "string", "required": false, "description": "挂载配置项参数", "example": "-odbglevel=info" }, { "name": "MountType", "type": "string", "required": false, "description": "挂载COS存储时支持的挂载工具；当前可选值：COSFS、GooseFS-Lite。", "example": "COSFS" } ] }, { "name": "OutputMappings", "type": "array", "required": false, "description": "输出映射", "example": "无", "item_type": "object", "children": [ { "name": "SourcePath", "type": "string", "required": true, "description": "源端路径", "example": "/home/output/" }, { "name": "DestinationPath", "type": "string", "required": true, "description": "目的端路径", "example": "cos://kelvin-test-125176278734.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "OutputMappingOption", "type": "object", "required": false, "description": "输出映射选项", "example": "无", "children": [ { "name": "Workspace", "type": "string", "required": false, "description": "容器场景下,输出选项从实例映射到容器内的实例侧的工作空间。 BATCH_WORKSPACE: 工作空间为BATCH在实例内定义的工作空间，BATCH侧保证作业之间的隔离。（默认） GLOBAL_WORKSPACE: 工作空间为实例操作系统空间。", "example": "BATCH_WORKSPACE" } ] } ] }, { "name": "OutputMappingConfigs", "type": "array", "required": false, "description": "输出映射配置", "example": "无", "item_type": "object", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "存储类型，仅支持COS", "example": "COS" }, { "name": "WorkerNum", "type": "integer", "required": true, "description": "并行worker数量", "example": "5" }, { "name": "WorkerPartSize", "type": "integer", "required": true, "description": "worker分块大小，单位MB", "example": "100" } ] }, { "name": "EnvVars", "type": "array", "required": false, "description": "自定义环境变量", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "环境变量名称", "example": "batch_demo" }, { "name": "Value", "type": "string", "required": true, "description": "环境变量取值", "example": "first_demo" } ] }, { "name": "Authentications", "type": "array", "required": false, "description": "授权信息", "example": "无", "item_type": "object", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "授权场景，例如COS", "example": "COS" }, { "name": "SecretId", "type": "string", "required": true, "description": "SecretId", "example": "AKIDUdi16HNjSuTl027Q9ThAzpuXIjNx" }, { "name": "SecretKey", "type": "string", "required": true, "description": "SecretKey", "example": "Udi16HNjSuTl027Q9ThAzpuXIjN" } ] }, { "name": "FailedAction", "type": "string", "required": false, "description": "TaskInstance失败后处理方式，取值包括 - TERMINATE：销毁计算实例（默认）、 - INTERRUPT：中断任务，保留计算实例、 - FAST_INTERRUPT： 快速中断任务， 保留计算实例。", "example": "TERMINATE" }, { "name": "MaxRetryCount", "type": "integer", "required": false, "description": "任务失败后的最大重试次数，默认为0", "example": "0" }, { "name": "Timeout", "type": "integer", "required": false, "description": "任务启动后的超时时间，单位秒，默认为86400秒", "example": "86400" }, { "name": "MaxConcurrentNum", "type": "integer", "required": false, "description": "任务最大并发数限制，默认没有限制。", "example": "100" }, { "name": "RestartComputeNode", "type": "boolean", "required": false, "description": "任务完成后，重启计算节点。适用于指定计算环境执行任务。", "example": "false" }, { "name": "ResourceMaxRetryCount", "type": "integer", "required": false, "description": "启动任务过程中，创建计算资源如CVM失败后的最大重试次数，默认为0。最大值100。 计算资源创建重试的等待时间间隔策略设置如下： [1, 3]: 等待600 s发起重试； [4, 10]: 等待900 s发起重试； [11, 50]: 等待1800 s发起重试； [51, 100]: 等待3600 s发起重试； [a, b]表示重试次数区间，每次重试的等待时间随着重试次数的增加而递增。 例如，计算资源创建重试8次的耗时为：3*600 + 5*900 = 6300 s", "example": "1" } ] }, { "name": "TaskTemplateDescription", "type": "string", "required": false, "description": "任务模板描述，最大长度限制200个字符。", "example": "test template" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表。通过指定该参数可以支持绑定标签到任务模板。每个任务模板最多绑定10个标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键。", "example": "batch_tag" }, { "name": "Value", "type": "string", "required": true, "description": "标签值。", "example": "batch-demo" } ] } ], "required": [ "TaskTemplateName", "TaskTemplateInfo" ] }, { "name": "DeleteComputeEnv", "description": "用于删除计算环境", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取，不能对状态处于删除中或者存在计算实例未销毁的环境发起删除动作。", "example": "env-3dhmblr3" } ], "required": [ "EnvId" ] }, { "name": "DeleteJob", "description": "用于删除作业记录。 删除作业的效果相当于删除作业相关的所有信息。删除成功后，作业相关的所有信息都无法查询。 待删除的作业必须处于完结状态，且其内部包含的所有任务实例也必须处于完结状态，否则会禁止操作。完结状态，是指处于 SUCCEED 或 FAILED 状态。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID；JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)", "example": "job-f5da1edl" } ], "required": [ "JobId" ] }, { "name": "DeleteTaskTemplates", "description": "用于删除任务模板信息", "status": "online", "parameters": [ { "name": "TaskTemplateIds", "type": "array", "required": true, "description": "用于删除任务模板信息，最大数量上限100，环境模版ID通过调用接口 [DescribeTaskTemplates](https://cloud.tencent.com/document/api/599/15902)获取。", "example": "[\"task-tmpl-7vtx96n2\"]", "item_type": "string" } ], "required": [ "TaskTemplateIds" ] }, { "name": "DescribeAvailableCvmInstanceTypes", "description": "查看可用的CVM机型配置信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 zone - String - 是否必填：否 -（过滤条件）按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。 instance-family String - 是否必填：否 -（过滤条件）按照[机型系列](https://cloud.tencent.com/document/product/213/15748)过滤。实例机型系列形如：S1、I1、M1等。", "example": "\t[{\"Name\":\"zone\",\"Values\":[\"ap-guangzhou-1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeComputeEnv", "description": "用于查询计算环境的详细信息", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取。", "example": "env-lcpcej85" } ], "required": [ "EnvId" ] }, { "name": "DescribeComputeEnvActivities", "description": "用于查询计算环境的活动信息", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取。", "example": "env-lcpcej85" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0.", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值20，最大值100.", "example": "100" }, { "name": "Filters", "type": "object", "required": false, "description": "过滤条件 compute-node-id - String - 是否必填：否 -（过滤条件）按照计算节点ID过滤，节点ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [ "EnvId" ] }, { "name": "DescribeComputeEnvCreateInfo", "description": "查看计算环境的创建信息。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取。", "example": "env-lcpcej85" } ], "required": [ "EnvId" ] }, { "name": "DescribeComputeEnvCreateInfos", "description": "用于查看计算环境创建信息列表，包括名称、描述、类型、环境参数、通知及期望节点数等。", "status": "online", "parameters": [ { "name": "EnvIds", "type": "array", "required": false, "description": "计算环境ID列表，与Filters参数不能同时指定，最大限制100，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取。", "example": "[\"env-5o4gphir\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 zone - String - 是否必填：否 -（过滤条件）按照可用区过滤，可用区通过调用接口 [DescribeZones](https://cloud.tencent.com/document/api/213/15707)获取。 env-id - String - 是否必填：否 -（过滤条件）按照计算环境ID过滤。 env-name - String - 是否必填：否 -（过滤条件）按照计算环境名称过滤。与EnvIds参数不能同时指定。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值20，最大值100。", "example": "100" } ], "required": [] }, { "name": "DescribeComputeEnvs", "description": "用于查看计算环境列表", "status": "online", "parameters": [ { "name": "EnvIds", "type": "array", "required": false, "description": "计算环境ID列表，与Filters参数不能同时指定。最大数量上限100。", "example": "[\"env-lcx7qbbr\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 zone - String - 是否必填：否 -（过滤条件）按照可用区过滤，可用区通过调用接口 [DescribeZones](https://cloud.tencent.com/document/api/213/15707)获取。 env-id - String - 是否必填：否 -（过滤条件）按照计算环境ID过滤。 env-name - String - 是否必填：否 -（过滤条件）按照计算环境名称过滤。 resource-type - String - 是否必填：否 -（过滤条件）按照计算资源类型过滤，取值CVM或者CPM(黑石)。 ta...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值20，最大值100。", "example": "20" } ], "required": [] }, { "name": "DescribeCvmZoneInstanceConfigInfos", "description": "获取批量计算可用区机型配置信息", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 zone - String - 是否必填：否 -（过滤条件）按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。 instance-family String - 是否必填：否 -（过滤条件）按照[机型系列](https://cloud.tencent.com/document/product/213/15748)过滤。实例机型系列形如：S1、I1、M1等。 instance-type - String - 是否必填：否 - （过滤条件）按照[机型](https://cloud.tencent.com/document/product/213/15749)过滤。实例机型形\ufffd...", "example": "[{\"Name\":\"zone\",\"Values\":[\"ap-guangzhou-1\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeInstanceCategories", "description": "目前对CVM现有实例族分类，每一类包含若干实例族。该接口用于查询实例分类信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeJob", "description": "用于查看一个作业的详细信息，包括内部任务（Task）和依赖（Dependence）信息。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID；JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)", "example": "job-97zcl3wt" } ], "required": [ "JobId" ] }, { "name": "DescribeJobMonitorData", "description": "查询作业任务实例的资源使用监控信息。当前只支持查询弹性节点任务并且Job未删除；暂不支持计算环境类任务；该接口只支持查询作业实例时间范围之内的资源使用情况。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID；JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)", "example": "job-97zcl3wt" }, { "name": "TaskName", "type": "string", "required": true, "description": "作业的Task名称，详见[作业详情](https://cloud.tencent.com/document/product/599/15904)。", "example": "demo-1" }, { "name": "TaskInstanceIndex", "type": "integer", "required": true, "description": "作业任务实例的序号，详见[任务详情](https://cloud.tencent.com/document/product/599/15905)", "example": "0" }, { "name": "MetricName", "type": "string", "required": true, "description": "支持查询的指标；当前支持查询的任务指标； - CpuUsage：cpu利用率，单位：% - MemUsage：内存利用率，单位：% - LanOuttraffic：内网出带宽，单位：Bytes/s - LanIntraffic：内网入带宽，单位：Bytes/s - MaxDiskUsage：所有磁盘中的使用率最高的磁盘使用率，单位：% - TargetDiskUsage：指定磁盘的使用率，单位：%；配合Dimensions参数使用", "example": "CpuUsage" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询任务实例的起始时间；如果未传入查询起始时间或传入的时间小于任务实例的创建时间（任务实例创建时间详见[任务详情](https://cloud.tencent.com/document/product/599/15905)），会自动将查询时间调整到任务实例的创建时间。传入时间格式只支持零时区格式。", "example": "2025-06-11T21:12:50Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询任务实例的终止时间；如果未传入查询终止时间或传入的时间大于任务实例的终止时间（任务实例终止时间详见[任务详情](https://cloud.tencent.com/document/product/599/15905)），并且任务实例已经结束，会自动将查询终止时间调整到任务实例的终止时间；如果任务实例未结束，会自动将查询终止时间调整到当前时间。传入时间格式只支持零时区格式。", "example": "2025-06-11T22:12:50Z" }, { "name": "Dimensions", "type": "array", "required": false, "description": "查询指标的扩展参数；当前只支持TargetDiskUsage; - TargetDiskUsage -支持的查询维度diskname, 维度值为磁盘挂载名，例如vdb；如果不传此参数，默认查询vdb磁盘的使用率。 样例：[{\"Name\":\"diskname\", \"Value\":\"vdb\"}]", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "查询指标的维度名称", "example": "diskname" }, { "name": "Value", "type": "string", "required": true, "description": "查询指标的维度值", "example": "vdb" } ] } ], "required": [ "JobId", "TaskName", "TaskInstanceIndex", "MetricName" ] }, { "name": "DescribeJobSubmitInfo", "description": "用于查询指定作业的提交信息，其返回内容包括 JobId 和 SubmitJob 接口中作为输入参数的作业提交信息", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID；JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)", "example": "job-97zcl3wt" } ], "required": [ "JobId" ] }, { "name": "DescribeJobs", "description": "用于查询若干个作业的概览信息", "status": "online", "parameters": [ { "name": "JobIds", "type": "array", "required": false, "description": "作业ID列表，与Filters参数不能同时指定。", "example": "[\"job-7e7evk2x\",\"job-3n2weaqt\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 job-id - String - 是否必填：否 -（过滤条件）按照作业ID过滤。 job-name - String - 是否必填：否 -（过滤条件）按照作业名称过滤。 job-state - String - 是否必填：否 -（过滤条件）按照作业状态过滤。 - SUBMITTED：已提交； - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。 zone - String ...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回job数量限制，最大值: 100，默认值: 20.", "example": "100" } ], "required": [] }, { "name": "DescribeTask", "description": "用于查询指定任务的详细信息，包括任务内部的任务实例信息。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID；JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)", "example": "job-97zcl3wt" }, { "name": "TaskName", "type": "string", "required": true, "description": "任务名称", "example": "A" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量。默认取值100，最大取值1000。", "example": "100" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，详情如下： task-instance-state - String - 是否必填： 否 - 按照任务实例状态进行过滤（ - SUBMITTED：已提交； - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例）。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [ "JobId", "TaskName" ] }, { "name": "DescribeTaskLogs", "description": "用于获取任务多个实例标准输出和标准错误日志。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID。JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)。", "example": "job-mawzp3ja" }, { "name": "TaskName", "type": "string", "required": true, "description": "任务名称", "example": "task" }, { "name": "TaskInstanceIndexes", "type": "array", "required": false, "description": "任务实例集合；与Offset不能同时指定。", "example": "[0, 1]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "起始任务实例。与TaskInstanceIndexes参数不能同时指定。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "最大任务实例数；默认值为5， 最大值为10。", "example": "10" } ], "required": [ "JobId", "TaskName" ] }, { "name": "DescribeTaskTemplates", "description": "用于查询任务模板信息", "status": "online", "parameters": [ { "name": "TaskTemplateIds", "type": "array", "required": false, "description": "任务模板ID列表，与Filters参数不能同时指定。模版ID最大限制100.", "example": "[\"task-tmpl-pq24rq1e\",\"task-tmpl-606i415o\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件 task-template-name - String - 是否必填：否 -（过滤条件）按照任务模板名称过滤。 tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - String - 是否必填：否 -（过滤条件）按照标签值进行过滤。 tag:tag-key - String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 与TaskTemplateIds参数不能同时指定。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量; 可选范围[1-100]；默认值为20。", "example": "10" } ], "required": [] }, { "name": "DetachInstances", "description": "将添加到计算环境中的实例从计算环境中移出。若是由批量计算自动创建的计算节点实例则不允许移出。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取。", "example": "env-1mekuyxs" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表，实例ID通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728)获取。", "example": "[\"ins-kjoossv5\"]", "item_type": "string" } ], "required": [ "EnvId", "InstanceIds" ] }, { "name": "ModifyComputeEnv", "description": "用于修改计算环境属性", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取。", "example": "env-lcpcej85" }, { "name": "DesiredComputeNodeCount", "type": "integer", "required": false, "description": "计算节点期望个数，最大上限2000。", "example": "2" }, { "name": "EnvName", "type": "string", "required": false, "description": "计算环境名称", "example": "test-env" }, { "name": "EnvDescription", "type": "string", "required": false, "description": "计算环境描述", "example": "test-env" }, { "name": "EnvData", "type": "object", "required": false, "description": "计算环境属性数据", "example": "无", "children": [ { "name": "InstanceTypes", "type": "array", "required": true, "description": "CVM实例类型列表", "example": "[\"SA2.MEDIUM4\",\"SA5.MEDIUM4\"]", "item_type": "string" } ] } ], "required": [ "EnvId" ] }, { "name": "ModifyTaskTemplate", "description": "用于修改任务模板", "status": "online", "parameters": [ { "name": "TaskTemplateId", "type": "string", "required": true, "description": "任务模板ID; 详见[任务模版](https://cloud.tencent.com/document/product/599/15902)。", "example": "task-tmpl-606i415o" }, { "name": "TaskTemplateName", "type": "string", "required": false, "description": "任务模板名称；字节长度限制60。", "example": "A" }, { "name": "TaskTemplateDescription", "type": "string", "required": false, "description": "任务模板描述；字节长度限制200。", "example": "first template" }, { "name": "TaskTemplateInfo", "type": "object", "required": false, "description": "任务模板信息", "example": "无", "children": [ { "name": "Application", "type": "object", "required": true, "description": "应用程序信息", "example": "无", "children": [ { "name": "DeliveryForm", "type": "string", "required": true, "description": "应用程序的交付方式，包括PACKAGE、LOCAL 两种取值，分别指远程存储的软件包、计算环境本地。", "example": "LOCAL" }, { "name": "Command", "type": "string", "required": false, "description": "松耦合任务执行命令。与Commands不能同时指定，一般使用Command字段提交任务。", "example": "sleep 10" }, { "name": "PackagePath", "type": "string", "required": false, "description": "应用程序软件包的远程存储路径", "example": "cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/demon_job.tar.gz" }, { "name": "Docker", "type": "object", "required": false, "description": "应用使用Docker的相关配置。在使用Docker配置的情况下，DeliveryForm 为 LOCAL 表示直接使用Docker镜像内部的应用软件，通过Docker方式运行；DeliveryForm 为 PACKAGE，表示将远程应用包注入到Docker镜像后，通过Docker方式运行。为避免Docker不同版本的兼容性问题，Docker安装包及相关依赖由Batch统一负责，对于已安装Docker的自定义镜像，请卸载后再使用Docker特性。", "example": "无", "children": [ { "name": "Image", "type": "string", "required": true, "description": "Docker Hub填写“[user/repo]:[tag]”，Tencent Registry填写“ccr.ccs.tencentyun.com/[namespace/repo]:[tag]”", "example": "kelvin-batch-test.tencentcloudcr.com/test/kelvin-test:v1" }, { "name": "User", "type": "string", "required": false, "description": "Docker Hub 用户名或 Tencent Registry 用户名；公共镜像可不填写此参数。", "example": "22372874874" }, { "name": "Password", "type": "string", "required": false, "description": "Docker Hub 密码或 Tencent Registry 密码；公共镜像可不填写此参数。", "example": "yJhbGciOiJSUzI1NiIsImtpZCI6IjJEQUg6UkNMUDpSSENTOkxNQ1g6UVBHTjpFWlhGOlBYTEo6MlpSTDpYNk9NOk5NVlE6NVNPUDpHU1AzIn0.ey" }, { "name": "Server", "type": "string", "required": false, "description": "Docker Hub 可以不填，但确保具有公网访问能力。或者是 Tencent Registry 服务地址“ccr.ccs.tencentyun.com”", "example": "kelvin-batch-test.tencentcloudcr.com" }, { "name": "MaxRetryCount", "type": "integer", "required": false, "description": "拉取Docker镜像重试次数。默认值：0。", "example": "0" }, { "name": "DelayOnRetry", "type": "integer", "required": false, "description": "拉取Docker镜像失败时延迟时间。单位：秒。", "example": "1" }, { "name": "DockerRunOption", "type": "string", "required": false, "description": "Docker命令运行参数。", "example": "-u root" } ] }, { "name": "Commands", "type": "array", "required": false, "description": "紧耦合任务执行命令信息。与Command不能同时指定。Command和Commands必须指定一个。", "example": "无", "item_type": "object", "children": [ { "name": "Command", "type": "string", "required": true, "description": "任务执行命令。", "example": "echo hello world" } ] } ] }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称，在一个作业内部唯一", "example": "test-task" }, { "name": "TaskInstanceNum", "type": "integer", "required": false, "description": "任务实例运行个数，默认为1", "example": "1" }, { "name": "ComputeEnv", "type": "object", "required": false, "description": "运行环境信息，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。", "example": "无", "children": [ { "name": "EnvType", "type": "string", "required": false, "description": "计算环境管理类型", "example": "MANAGED" }, { "name": "EnvData", "type": "object", "required": false, "description": "计算环境具体参数", "example": "无", "children": [ { "name": "InstanceType", "type": "string", "required": false, "description": "CVM实例类型，不能与InstanceTypes和InstanceTypeOptions同时出现。", "example": "SA5.MEDIUM2" }, { "name": "ImageId", "type": "string", "required": false, "description": "CVM镜像ID", "example": "img-jsdt6r36" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息", "example": "无" }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息", "example": "无", "item_type": "string" }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置，与Zones和VirtualPrivateClouds不能同时指定。", "example": "无" }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置", "example": "无" }, { "name": "InstanceName", "type": "string", "required": false, "description": "CVM实例显示名称", "example": "demo" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置", "example": "无" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组", "example": "[\"sg-dec9tgiy\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。", "example": "无" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "CVM实例计费类型POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数", "example": "无" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "CVM实例类型列表，不能与InstanceType和InstanceTypeOptions同时出现。指定该字段后，计算节点按照机型先后顺序依次尝试创建，直到实例创建成功，结束遍历过程。最多支持10个机型。", "example": "[\"SA5.MEDIUM2\"]", "item_type": "string" }, { "name": "InstanceTypeOptions", "type": "object", "required": false, "description": "CVM实例机型配置。不能与InstanceType和InstanceTypes同时出现。", "example": "无" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区列表，支持跨可用区创建CVM实例。与VirtualPrivateCloud和VirtualPrivateClouds不能同时指定。", "example": "[\"ap-guangzhou-2\"]", "item_type": "string" }, { "name": "VirtualPrivateClouds", "type": "array", "required": false, "description": "私有网络列表，支持跨私有网络创建CVM实例。与VirtualPrivateCloud和Zones不能同时指定。", "example": "无", "item_type": "string" } ] }, { "name": "MountDataDisks", "type": "array", "required": false, "description": "数据盘挂载选项", "example": "无", "item_type": "object", "children": [ { "name": "LocalPath", "type": "string", "required": true, "description": "挂载点，Linux系统合法路径，或Windows系统盘符,比如\"H:\\\\\"", "example": "/data/tmp" }, { "name": "FileSystemType", "type": "string", "required": false, "description": "文件系统类型，Linux系统下支持\"EXT3\"和\"EXT4\"两种，默认\"EXT3\"；Windows系统下仅支持\"NTFS\"", "example": "EXT3" } ] }, { "name": "AgentRunningMode", "type": "object", "required": false, "description": "agent运行模式，适用于Windows系统", "example": "无", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "场景类型，支持WINDOWS", "example": "WINDOWS" }, { "name": "User", "type": "string", "required": true, "description": "运行Agent的User", "example": "12348349197419" }, { "name": "Session", "type": "string", "required": true, "description": "运行Agent的Session", "example": "95af4dd1-c6cd-4294-9439-f55028895c62" } ] } ] }, { "name": "EnvId", "type": "string", "required": false, "description": "计算环境ID，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。", "example": "env_238swek2" }, { "name": "RedirectInfo", "type": "object", "required": false, "description": "重定向信息", "example": "无", "children": [ { "name": "StdoutRedirectPath", "type": "string", "required": false, "description": "标准输出重定向路径;", "example": "cos://kelvin-test-1351762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "StderrRedirectPath", "type": "string", "required": false, "description": "标准错误重定向路径", "example": "cos://kelvin-test-1351762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "StdoutRedirectFileName", "type": "string", "required": false, "description": "标准输出重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "demo_stdout.log" }, { "name": "StderrRedirectFileName", "type": "string", "required": false, "description": "标准错误重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "demo_stderr.log" } ] }, { "name": "RedirectLocalInfo", "type": "object", "required": false, "description": "重定向本地信息", "example": "无", "children": [ { "name": "StdoutLocalPath", "type": "string", "required": false, "description": "标准输出重定向本地路径", "example": "/tmp/log/" }, { "name": "StderrLocalPath", "type": "string", "required": false, "description": "标准错误重定向本地路径", "example": "/tmp/log/" }, { "name": "StdoutLocalFileName", "type": "string", "required": false, "description": "标准输出重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "job-5ewdqncb-stdout.log" }, { "name": "StderrLocalFileName", "type": "string", "required": false, "description": "标准错误重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "job-5ewdqncb-stderr.log" } ] }, { "name": "InputMappings", "type": "array", "required": false, "description": "输入映射", "example": "无", "item_type": "object", "children": [ { "name": "SourcePath", "type": "string", "required": true, "description": "源端路径", "example": "cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "DestinationPath", "type": "string", "required": true, "description": "目的端路径", "example": "/home/input/" }, { "name": "MountOptionParameter", "type": "string", "required": false, "description": "挂载配置项参数", "example": "-odbglevel=info" }, { "name": "MountType", "type": "string", "required": false, "description": "挂载COS存储时支持的挂载工具；当前可选值：COSFS、GooseFS-Lite。", "example": "COSFS" } ] }, { "name": "OutputMappings", "type": "array", "required": false, "description": "输出映射", "example": "无", "item_type": "object", "children": [ { "name": "SourcePath", "type": "string", "required": true, "description": "源端路径", "example": "/home/output/" }, { "name": "DestinationPath", "type": "string", "required": true, "description": "目的端路径", "example": "cos://kelvin-test-125176278734.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "OutputMappingOption", "type": "object", "required": false, "description": "输出映射选项", "example": "无", "children": [ { "name": "Workspace", "type": "string", "required": false, "description": "容器场景下,输出选项从实例映射到容器内的实例侧的工作空间。 BATCH_WORKSPACE: 工作空间为BATCH在实例内定义的工作空间，BATCH侧保证作业之间的隔离。（默认） GLOBAL_WORKSPACE: 工作空间为实例操作系统空间。", "example": "BATCH_WORKSPACE" } ] } ] }, { "name": "OutputMappingConfigs", "type": "array", "required": false, "description": "输出映射配置", "example": "无", "item_type": "object", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "存储类型，仅支持COS", "example": "COS" }, { "name": "WorkerNum", "type": "integer", "required": true, "description": "并行worker数量", "example": "5" }, { "name": "WorkerPartSize", "type": "integer", "required": true, "description": "worker分块大小，单位MB", "example": "100" } ] }, { "name": "EnvVars", "type": "array", "required": false, "description": "自定义环境变量", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "环境变量名称", "example": "batch_demo" }, { "name": "Value", "type": "string", "required": true, "description": "环境变量取值", "example": "first_demo" } ] }, { "name": "Authentications", "type": "array", "required": false, "description": "授权信息", "example": "无", "item_type": "object", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "授权场景，例如COS", "example": "COS" }, { "name": "SecretId", "type": "string", "required": true, "description": "SecretId", "example": "AKIDUdi16HNjSuTl027Q9ThAzpuXIjNx" }, { "name": "SecretKey", "type": "string", "required": true, "description": "SecretKey", "example": "Udi16HNjSuTl027Q9ThAzpuXIjN" } ] }, { "name": "FailedAction", "type": "string", "required": false, "description": "TaskInstance失败后处理方式，取值包括 - TERMINATE：销毁计算实例（默认）、 - INTERRUPT：中断任务，保留计算实例、 - FAST_INTERRUPT： 快速中断任务， 保留计算实例。", "example": "TERMINATE" }, { "name": "MaxRetryCount", "type": "integer", "required": false, "description": "任务失败后的最大重试次数，默认为0", "example": "0" }, { "name": "Timeout", "type": "integer", "required": false, "description": "任务启动后的超时时间，单位秒，默认为86400秒", "example": "86400" }, { "name": "MaxConcurrentNum", "type": "integer", "required": false, "description": "任务最大并发数限制，默认没有限制。", "example": "100" }, { "name": "RestartComputeNode", "type": "boolean", "required": false, "description": "任务完成后，重启计算节点。适用于指定计算环境执行任务。", "example": "false" }, { "name": "ResourceMaxRetryCount", "type": "integer", "required": false, "description": "启动任务过程中，创建计算资源如CVM失败后的最大重试次数，默认为0。最大值100。 计算资源创建重试的等待时间间隔策略设置如下： [1, 3]: 等待600 s发起重试； [4, 10]: 等待900 s发起重试； [11, 50]: 等待1800 s发起重试； [51, 100]: 等待3600 s发起重试； [a, b]表示重试次数区间，每次重试的等待时间随着重试次数的增加而递增。 例如，计算资源创建重试8次的耗时为：3*600 + 5*900 = 6300 s", "example": "1" } ] } ], "required": [ "TaskTemplateId" ] }, { "name": "RetryJobs", "description": "用于重试作业中失败的任务实例。 仅当作业处于“FAILED”状态，支持重试操作。重试操作成功后，作业会按照有向无环图中指定的任务依赖关系，依次重试各个任务中失败的任务实例。任务实例的历史信息将被重置，如同首次运行一样，参与后续的调度和执行。", "status": "online", "parameters": [ { "name": "JobIds", "type": "array", "required": true, "description": "作业ID列表。最大重试作业数100；JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)。", "example": "[\"job-rybewp57\",\"job-97zcl3wt\"]", "item_type": "string" } ], "required": [ "JobIds" ] }, { "name": "SubmitJob", "description": "用于提交一个作业", "status": "online", "parameters": [ { "name": "Placement", "type": "object", "required": true, "description": "作业所提交的位置信息。通过该参数可以指定作业关联CVM所属可用区等信息。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-4" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 `ProjectId` 字段来获取。默认取值0，表示默认项目。", "example": "0" }, { "name": "HostIds", "type": "array", "required": false, "description": "实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 的返回值中的 `HostId` 字段来获取。", "example": "[\"host-o5i742go\"]", "item_type": "string" }, { "name": "HostId", "type": "string", "required": false, "description": "实例所属的专用宿主机ID，仅用于出参。", "example": "host-o5i742go" } ] }, { "name": "Job", "type": "object", "required": true, "description": "作业信息", "example": "无", "children": [ { "name": "Tasks", "type": "array", "required": true, "description": "任务信息", "example": "无", "item_type": "object", "children": [ { "name": "Application", "type": "object", "required": true, "description": "应用程序信息", "example": "无", "children": [ { "name": "DeliveryForm", "type": "string", "required": true, "description": "应用程序的交付方式，包括PACKAGE、LOCAL 两种取值，分别指远程存储的软件包、计算环境本地。", "example": "LOCAL" }, { "name": "Command", "type": "string", "required": false, "description": "松耦合任务执行命令。与Commands不能同时指定，一般使用Command字段提交任务。", "example": "sleep 10" }, { "name": "PackagePath", "type": "string", "required": false, "description": "应用程序软件包的远程存储路径", "example": "cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/demon_job.tar.gz" }, { "name": "Docker", "type": "object", "required": false, "description": "应用使用Docker的相关配置。在使用Docker配置的情况下，DeliveryForm 为 LOCAL 表示直接使用Docker镜像内部的应用软件，通过Docker方式运行；DeliveryForm 为 PACKAGE，表示将远程应用包注入到Docker镜像后，通过Docker方式运行。为避免Docker不同版本的兼容性问题，Docker安装包及相关依赖由Batch统一负责，对于已安装Docker的自定义镜像，请卸载后再使用Docker特性。", "example": "无" }, { "name": "Commands", "type": "array", "required": false, "description": "紧耦合任务执行命令信息。与Command不能同时指定。Command和Commands必须指定一个。", "example": "无", "item_type": "string" } ] }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称，在一个作业内部唯一", "example": "test-task" }, { "name": "TaskInstanceNum", "type": "integer", "required": false, "description": "任务实例运行个数，默认为1", "example": "1" }, { "name": "ComputeEnv", "type": "object", "required": false, "description": "运行环境信息，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。", "example": "无", "children": [ { "name": "EnvType", "type": "string", "required": false, "description": "计算环境管理类型", "example": "MANAGED" }, { "name": "EnvData", "type": "object", "required": false, "description": "计算环境具体参数", "example": "无" }, { "name": "MountDataDisks", "type": "array", "required": false, "description": "数据盘挂载选项", "example": "无", "item_type": "string" }, { "name": "AgentRunningMode", "type": "object", "required": false, "description": "agent运行模式，适用于Windows系统", "example": "无" } ] }, { "name": "EnvId", "type": "string", "required": false, "description": "计算环境ID，ComputeEnv 和 EnvId 必须指定一个（且只有一个）参数。", "example": "env_238swek2" }, { "name": "RedirectInfo", "type": "object", "required": false, "description": "重定向信息", "example": "无", "children": [ { "name": "StdoutRedirectPath", "type": "string", "required": false, "description": "标准输出重定向路径;", "example": "cos://kelvin-test-1351762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "StderrRedirectPath", "type": "string", "required": false, "description": "标准错误重定向路径", "example": "cos://kelvin-test-1351762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "StdoutRedirectFileName", "type": "string", "required": false, "description": "标准输出重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "demo_stdout.log" }, { "name": "StderrRedirectFileName", "type": "string", "required": false, "description": "标准错误重定向文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "demo_stderr.log" } ] }, { "name": "RedirectLocalInfo", "type": "object", "required": false, "description": "重定向本地信息", "example": "无", "children": [ { "name": "StdoutLocalPath", "type": "string", "required": false, "description": "标准输出重定向本地路径", "example": "/tmp/log/" }, { "name": "StderrLocalPath", "type": "string", "required": false, "description": "标准错误重定向本地路径", "example": "/tmp/log/" }, { "name": "StdoutLocalFileName", "type": "string", "required": false, "description": "标准输出重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "job-5ewdqncb-stdout.log" }, { "name": "StderrLocalFileName", "type": "string", "required": false, "description": "标准错误重定向本地文件名，支持三个占位符${BATCH_JOB_ID}、${BATCH_TASK_NAME}、${BATCH_TASK_INSTANCE_INDEX}", "example": "job-5ewdqncb-stderr.log" } ] }, { "name": "InputMappings", "type": "array", "required": false, "description": "输入映射", "example": "无", "item_type": "object", "children": [ { "name": "SourcePath", "type": "string", "required": true, "description": "源端路径", "example": "cos://kelvin-test-1251762227.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "DestinationPath", "type": "string", "required": true, "description": "目的端路径", "example": "/home/input/" }, { "name": "MountOptionParameter", "type": "string", "required": false, "description": "挂载配置项参数", "example": "-odbglevel=info" }, { "name": "MountType", "type": "string", "required": false, "description": "挂载COS存储时支持的挂载工具；当前可选值：COSFS、GooseFS-Lite。", "example": "COSFS" } ] }, { "name": "OutputMappings", "type": "array", "required": false, "description": "输出映射", "example": "无", "item_type": "object", "children": [ { "name": "SourcePath", "type": "string", "required": true, "description": "源端路径", "example": "/home/output/" }, { "name": "DestinationPath", "type": "string", "required": true, "description": "目的端路径", "example": "cos://kelvin-test-125176278734.cos.ap-nanjing.myqcloud.com/batch_test/" }, { "name": "OutputMappingOption", "type": "object", "required": false, "description": "输出映射选项", "example": "无" } ] }, { "name": "OutputMappingConfigs", "type": "array", "required": false, "description": "输出映射配置", "example": "无", "item_type": "object", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "存储类型，仅支持COS", "example": "COS" }, { "name": "WorkerNum", "type": "integer", "required": true, "description": "并行worker数量", "example": "5" }, { "name": "WorkerPartSize", "type": "integer", "required": true, "description": "worker分块大小，单位MB", "example": "100" } ] }, { "name": "EnvVars", "type": "array", "required": false, "description": "自定义环境变量", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "环境变量名称", "example": "batch_demo" }, { "name": "Value", "type": "string", "required": true, "description": "环境变量取值", "example": "first_demo" } ] }, { "name": "Authentications", "type": "array", "required": false, "description": "授权信息", "example": "无", "item_type": "object", "children": [ { "name": "Scene", "type": "string", "required": true, "description": "授权场景，例如COS", "example": "COS" }, { "name": "SecretId", "type": "string", "required": true, "description": "SecretId", "example": "AKIDUdi16HNjSuTl027Q9ThAzpuXIjNx" }, { "name": "SecretKey", "type": "string", "required": true, "description": "SecretKey", "example": "Udi16HNjSuTl027Q9ThAzpuXIjN" } ] }, { "name": "FailedAction", "type": "string", "required": false, "description": "TaskInstance失败后处理方式，取值包括 - TERMINATE：销毁计算实例（默认）、 - INTERRUPT：中断任务，保留计算实例、 - FAST_INTERRUPT： 快速中断任务， 保留计算实例。", "example": "TERMINATE" }, { "name": "MaxRetryCount", "type": "integer", "required": false, "description": "任务失败后的最大重试次数，默认为0", "example": "0" }, { "name": "Timeout", "type": "integer", "required": false, "description": "任务启动后的超时时间，单位秒，默认为86400秒", "example": "86400" }, { "name": "MaxConcurrentNum", "type": "integer", "required": false, "description": "任务最大并发数限制，默认没有限制。", "example": "100" }, { "name": "RestartComputeNode", "type": "boolean", "required": false, "description": "任务完成后，重启计算节点。适用于指定计算环境执行任务。", "example": "false" }, { "name": "ResourceMaxRetryCount", "type": "integer", "required": false, "description": "启动任务过程中，创建计算资源如CVM失败后的最大重试次数，默认为0。最大值100。 计算资源创建重试的等待时间间隔策略设置如下： [1, 3]: 等待600 s发起重试； [4, 10]: 等待900 s发起重试； [11, 50]: 等待1800 s发起重试； [51, 100]: 等待3600 s发起重试； [a, b]表示重试次数区间，每次重试的等待时间随着重试次数的增加而递增。 例如，计算资源创建重试8次的耗时为：3*600 + 5*900 = 6300 s", "example": "1" } ] }, { "name": "JobName", "type": "string", "required": false, "description": "作业名称; 字符串长度限制60.", "example": "test-job" }, { "name": "JobDescription", "type": "string", "required": false, "description": "作业描述；字符串长度限制200.", "example": "test-job" }, { "name": "Priority", "type": "integer", "required": false, "description": "作业优先级，任务（Task）和任务实例（TaskInstance）会继承作业优先级；范围0～100，数值越大，优先级越高。", "example": "1" }, { "name": "Dependences", "type": "array", "required": false, "description": "依赖信息", "example": "无", "item_type": "object", "children": [ { "name": "StartTask", "type": "string", "required": true, "description": "依赖关系的起点任务名称", "example": "TaskA" }, { "name": "EndTask", "type": "string", "required": true, "description": "依赖关系的终点任务名称", "example": "TaskB" } ] }, { "name": "Notifications", "type": "array", "required": false, "description": "通知信息", "example": "无", "item_type": "object", "children": [ { "name": "TopicName", "type": "string", "required": true, "description": "CMQ主题名字，要求主题名有效且关联订阅", "example": "demo" }, { "name": "EventConfigs", "type": "array", "required": true, "description": "事件配置", "example": "无", "item_type": "object", "children": [ { "name": "EventName", "type": "string", "required": true, "description": "事件类型，包括：“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”：任务失\ufffd\ufffd...", "example": "JOB_RUNNING" }, { "name": "EventVars", "type": "array", "required": true, "description": "自定义键值对", "example": "无", "item_type": "string" } ] } ] }, { "name": "TaskExecutionDependOn", "type": "string", "required": false, "description": "对于存在依赖关系的任务中，后序任务执行对于前序任务的依赖条件。取值范围包括 PRE_TASK_SUCCEED，PRE_TASK_AT_LEAST_PARTLY_SUCCEED，PRE_TASK_FINISHED，默认值为PRE_TASK_SUCCEED。", "example": "PRE_TASK_SUCCEED" }, { "name": "StateIfCreateCvmFailed", "type": "string", "required": false, "description": "表示创建 CVM 失败按照何种策略处理。取值范围包括 FAILED，RUNNABLE。FAILED 表示创建 CVM 失败按照一次执行失败处理，RUNNABLE 表示创建 CVM 失败按照继续等待处理。默认值为FAILED。StateIfCreateCvmFailed对于提交的指定计算环境的作业无效。", "example": "FAILED" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表。通过指定该参数可以支持绑定标签到作业。每个作业最多绑定10个标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键。", "example": "batch_tag" }, { "name": "Value", "type": "string", "required": true, "description": "标签值。", "example": "batch-demo" } ] }, { "name": "NotificationTarget", "type": "string", "required": false, "description": "表示通知信息的通知目标类型。 取值范围：CMQ，TDMQ_CMQ。 CMQ:表示向腾讯云CMQ发送消息。 TDMQ_CMQ：表示向腾讯云TDMQ_CMQ发送消息。默认值为CMQ。注：腾讯云计划于2022年6月前正式下线消息队列 CMQ，建议使用TDMQ_CMQ。参考文档：[CMQ迁移到TDMQ_CMQ](https://cloud.tencent.com/document/product/406/60860)", "example": "TDMQ_CMQ" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由用户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "fbad0aef-8441-4615-b904-c16779e33b" } ], "required": [ "Placement", "Job" ] }, { "name": "TerminateComputeNode", "description": "用于销毁计算节点。 对于状态为CREATED、CREATION_FAILED、RUNNING和ABNORMAL的节点，允许销毁处理。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnvs](https://cloud.tencent.com/document/api/599/15893)获取。", "example": "env-lcx7qbbr" }, { "name": "ComputeNodeId", "type": "string", "required": true, "description": "计算节点ID，节点ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。", "example": "node-lcpcej85" } ], "required": [ "EnvId", "ComputeNodeId" ] }, { "name": "TerminateComputeNodes", "description": "用于批量销毁计算节点，不允许重复销毁同一个节点。", "status": "online", "parameters": [ { "name": "EnvId", "type": "string", "required": true, "description": "计算环境ID，环境ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。", "example": "env-lcx7qbbr" }, { "name": "ComputeNodeIds", "type": "array", "required": true, "description": "计算节点ID列表，最大数量上限100，节点ID通过调用接口 [DescribeComputeEnv](https://cloud.tencent.com/document/api/599/15892)获取。", "example": "[\"node-k9fwel23\"]", "item_type": "string" } ], "required": [ "EnvId", "ComputeNodeIds" ] }, { "name": "TerminateJob", "description": "用于终止作业。 当作业处于“SUBMITTED”状态时，禁止终止操作；当作业处于“SUCCEED”状态时，终止操作不会生效。 终止作业是一个异步过程。整个终止过程的耗时和任务总数成正比。终止的效果相当于所含的所有任务实例进行[TerminateTaskInstance](https://cloud.tencent.com/document/product/599/15908)操作。具体效果和用法可参考[TerminateTaskInstance](https://cloud.tencent.com/document/product/599/15908)。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID；JobId详见[作业列表](https://cloud.tencent.com/document/product/599/15909)", "example": "job-rybewp57" } ], "required": [ "JobId" ] }, { "name": "TerminateTaskInstance", "description": "用于终止任务实例。 对于状态已经为“SUCCEED”和“FAILED”的任务实例，不做处理。 对于状态为“SUBMITTED”、“PENDING”、“RUNNABLE”的任务实例，状态将置为“FAILED”状态。 对于状态为“STARTING”、“RUNNING”、“FAILED_INTERRUPTED”的任务实例，区分两种情况：如果未显示指定计算环境，会先销毁CVM服务器，然后将状态置为“FAILED”，具有一定耗时；如果指定了计算环境EnvId，任\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID；详见[作业列表](https://cloud.tencent.com/document/product/599/15909)。", "example": "job-rybewp57" }, { "name": "TaskName", "type": "string", "required": true, "description": "任务名称；详见[作业提交信息](https://cloud.tencent.com/document/product/599/15910)", "example": "A" }, { "name": "TaskInstanceIndex", "type": "integer", "required": true, "description": "任务实例索引", "example": "0" } ], "required": [ "JobId", "TaskName", "TaskInstanceIndex" ] } ] }