1. 接口描述
接口请求域名: batch.tencentcloudapi.com 。
用于创建任务模板
默认接口请求频率限制:2次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTaskTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TaskTemplateName | 是 | String | 任务模板名称 示例值:A |
TaskTemplateInfo | 是 | Task | 任务模板内容,参数要求与任务一致 |
TaskTemplateDescription | 否 | String | 任务模板描述 示例值:test |
Tags.N | 否 | Array of Tag | 标签列表。通过指定该参数可以支持绑定标签到任务模板。每个任务模板最多绑定10个标签。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskTemplateId | String | 任务模板ID 示例值:task-tmpl-7vtx96n2 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建任务模板
输入示例
https://batch.tencentcloudapi.com/?Action=CreateTaskTemplate
&TaskTemplateName=A
&TaskTemplateDescription=test
&TaskTemplateInfo.TaskName=A
&TaskTemplateInfo.TaskInstanceNum=1
&TaskTemplateInfo.Application.DeliveryForm=LOCAL
&TaskTemplateInfo.Application.Command=python-c"fib=lambdan:1ifn<=2elsefib(n-1)+fib(n-2);print(fib(20))"
&TaskTemplateInfo.ComputeEnv.EnvType=MANAGED
&TaskTemplateInfo.ComputeEnv.EnvData.InstanceType=S1.SMALL1
&TaskTemplateInfo.ComputeEnv.EnvData.ImageId=img-bd78fy2t
&TaskTemplateInfo.RedirectInfo.StdoutRedirectPath=cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/
&TaskTemplateInfo.RedirectInfo.StderrRedirectPath=cos://bucket-appid.cosgz.myqcloud.com/hello2/logs/
&<公共请求参数>
输出示例
{
"Response": {
"TaskTemplateId": "task-tmpl-7vtx96n2",
"RequestId": "83cd875b-7ac0-4e5b-b150-0e69c59e5e52"
}
}
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.CallTagAPI | 获取Tag错误。 |
InvalidParameter.CvmParameters | 非法的CVM参数。 |
InvalidParameter.EnvIdMalformed | 非法的计算环境ID格式。 |
InvalidParameter.ImageIdMalformed | 镜像ID不正确。 |
InvalidParameter.TaskName | 非法的任务名称。 |
InvalidParameter.TaskNameTooLong | 任务名称过长。 |
InvalidParameter.TaskTemplateName | 非法的任务模板名称。 |
InvalidParameter.TaskTemplateNameTooLong | 任务模板名称过长。 |
InvalidParameterValue.ComputeEnv | 计算环境参数校验失败。 |
InvalidParameterValue.DependenceNotFoundTaskName | 找不到依赖任务定义。 |
InvalidParameterValue.DependenceUnfeasible | 禁止环状任务依赖关系。 |
InvalidParameterValue.InvalidDataTypeAny | DataTypeAny不合法。 |
InvalidParameterValue.LocalPath | 非法的本地存储路径。 |
InvalidParameterValue.MaxRetryCount | 重试次数过大。 |
InvalidParameterValue.Negative | 非法的负值参数。 |
InvalidParameterValue.RemoteStoragePath | 非法的存储路径格式。 |
InvalidParameterValue.RemoteStorageSchemeType | 非法的存储类型。 |
LimitExceeded.TaskTemplateQuota | 任务模板配额不足。 |