1. 接口描述
接口请求域名: batch.tencentcloudapi.com 。
用于提交一个作业
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SubmitJob。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Placement | 是 | Placement | 作业所提交的位置信息。通过该参数可以指定作业关联CVM所属可用区等信息。 |
Job | 是 | Job | 作业信息 |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由用户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobId | String | 当通过本接口来提交作业时会返回该参数,表示一个作业ID。返回作业ID列表并不代表作业解析/运行成功,可根据 DescribeJob 接口查询其状态。 示例值:job-4yn0we13 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交作业
输入示例
https://batch.tencentcloudapi.com/?Action=SubmitJob
&Placement.Zone=ap-guangzhou-2
&Job.JobName=test
&Job.JobDescription=test
&Job.Priority=1
&Job.Tasks.0.TaskName=hello2
&Job.Tasks.0.TaskInstanceNum=1
&Job.Tasks.0.Application.DeliveryForm=LOCAL
&Job.Tasks.0.Application.Command=python -c "fib=lambda n:1 if n<=2 else fib(n-1)+fib(n-2); print(fib(20))"
&Job.Tasks.0.ComputeEnv.EnvType=MANAGED
&Job.Tasks.0.ComputeEnv.EnvData.InstanceType=S1.SMALL1
&Job.Tasks.0.ComputeEnv.EnvData.ImageId=img-bd78fy2t
&Job.Tasks.0.RedirectInfo.StdoutRedirectPath=cos://dondonbatch-1251783334.cosgz.myqcloud.com/hello2/logs/
&Job.Tasks.0.RedirectInfo.StderrRedirectPath=cos://dondonbatch-1251783334.cosgz.myqcloud.com/hello2/logs/
&<公共请求参数>
输出示例
{
"Response": {
"JobId": "job-4yn0we13",
"RequestId": "bf2a9734-e485-423f-9d73-a93f5e6c6a0c"
}
}
示例2 提交DAG型作业,具有依赖关系
输入示例
https://batch.tencentcloudapi.com/?Action=SubmitJob
&Placement.Zone=ap-beijing-2
&Job.JobName=dag
&Job.JobDescription=dag_demo
&Job.Tasks.0.TaskName=pre_task
&Job.Tasks.0.TaskInstanceNum=1
&Job.Tasks.0.Application.DeliveryForm=LOCAL
&Job.Tasks.0.Application.Command=echo pre_task
&Job.Tasks.0.ComputeEnv.EnvData.InstanceType=S2.SMALL1
&Job.Tasks.0.RedirectInfo.StdoutRedirectPath=cos://batch-demo-1251783334.cosbj.myqcloud.com/logs/
&Job.Tasks.0.RedirectInfo.StderrRedirectPath=cos://batch-demo-1251783334.cosbj.myqcloud.com/logs/
&Job.Tasks.1.TaskName=post_task
&Job.Tasks.1.TaskInstanceNum=1
&Job.Tasks.1.Application.DeliveryForm=LOCAL
&Job.Tasks.1.Application.Command=echo post_task
&Job.Tasks.1.ComputeEnv.EnvData.InstanceType=S2.SMALL1
&Job.Tasks.1.RedirectInfo.StdoutRedirectPath=cos://batch-demo-1251783334.cosbj.myqcloud.com/logs/
&Job.Tasks.1.RedirectInfo.StderrRedirectPath=cos://batch-demo-1251783334.cosbj.myqcloud.com/logs/
&Job.Dependences.0.StartTask=pre_task
&Job.Dependences.0.EndTask=post_task
&<公共请求参数>
输出示例
{
"Response": {
"JobId": "job-2bmv4p7o",
"RequestId": "165dc518-52a4-4363-8ea4-14f1ee8dea1a"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AllowedOneAttributeInEnvIdAndComputeEnv | ComputeEnv 和 EnvId 必须指定一个(且只有一个)参数。 |
InternalError | 内部错误。 |
InternalError.CallCam | 调用CAM API返回错误。 |
InternalError.CallCvm | 调用CVM API返回错误。 |
InternalError.CallTagAPI | 获取Tag错误。 |
InvalidParameter.CvmParameters | 非法的CVM参数。 |
InvalidParameter.EnvIdMalformed | 非法的计算环境ID格式。 |
InvalidParameter.ImageIdMalformed | 镜像ID不正确。 |
InvalidParameter.InvalidParameterCombination | 非法的参数组合。 |
InvalidParameter.JobDescriptionTooLong | 作业描述过长。 |
InvalidParameter.JobNameTooLong | 作业名称过长。 |
InvalidParameter.NotificationEventNameDuplicate | 重复的消息通知事件名称。 |
InvalidParameter.NotificationTopicName | 非法的主题名称。 |
InvalidParameter.NotificationTopicNameTooLong | 主题名称过长。 |
InvalidParameter.TaskName | 非法的任务名称。 |
InvalidParameter.TaskNameTooLong | 任务名称过长。 |
InvalidParameterValue.ComputeEnv | 计算环境参数校验失败。 |
InvalidParameterValue.DependenceNotFoundTaskName | 找不到依赖任务定义。 |
InvalidParameterValue.DependenceUnfeasible | 禁止环状任务依赖关系。 |
InvalidParameterValue.InstanceTypeDuplicate | 实例类型不能有重复值。 |
InvalidParameterValue.InvalidDataTypeAny | DataTypeAny不合法。 |
InvalidParameterValue.InvalidZoneMismatchRegion | 可用区和地域不匹配。 |
InvalidParameterValue.LimitExceeded | Filter参数值数量超过限制。 |
InvalidParameterValue.LocalPath | 非法的本地存储路径。 |
InvalidParameterValue.MaxRetryCount | 重试次数过大。 |
InvalidParameterValue.Negative | 非法的负值参数。 |
InvalidParameterValue.NotFloat | 参数值不是浮点型。 |
InvalidParameterValue.RemoteStoragePath | 非法的存储路径格式。 |
InvalidParameterValue.RemoteStorageSchemeType | 非法的存储类型。 |
InvalidParameterValue.UnavailableZone | Zone不可用。 |
InvalidZone.MismatchRegion | 指定的zone不存在。 |
LimitExceeded.JobQuota | 作业配额不足。 |
ResourceNotFound.ComputeEnv | 指定计算环境不存在。 |
UnauthorizedOperation.UserNotAllowedToUseBatch | 禁止使用批量计算服务。 |