CreateTaskTemplate

Prev Next

search by keyword

Recent Pages

Documentation

Last updated: 2021-09-01 11:36:37

1. API Description

Domain name for API request: batch.tencentcloudapi.com.

This API is used to create a task template.

A maximum of 2 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: CreateTaskTemplate.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
TaskTemplateName	Yes	String	Task template name
TaskTemplateInfo	Yes	Task	Task template content with the same parameter requirements as the task
TaskTemplateDescription	No	String	Task template description
Tags.N	No	Array of Tag	Tag list. By setting this parameter, you can bind tags to a task template. Each task template supports up to 10 tags.

3. Output Parameters

Parameter Name	Type	Description
TaskTemplateId	String	Task template ID
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a task template

Input Example

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/
&<Common request parameters>

Output Example

{
  "Response": {
    "TaskTemplateId": "task-tmpl-7vtx96n2",
    "RequestId": "83cd875b-7ac0-4e5b-b150-0e69c59e5e52"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
AllowedOneAttributeInEnvIdAndComputeEnv	One (and only one) parameter must be specified for ComputeEnv and EnvId.
InternalError	Internal error.
InternalError.CallTagAPI	Error while obtaining the Tag component.
InvalidParameter.CvmParameters	Invalid CVM parameter.
InvalidParameter.EnvIdMalformed	Invalid compute environment ID format.
InvalidParameter.TaskName	Invalid job name.
InvalidParameter.TaskNameTooLong	The task name is too long.
InvalidParameter.TaskTemplateName	Invalid task template name.
InvalidParameter.TaskTemplateNameTooLong	The task template name is too long.
InvalidParameterValue.ComputeEnv	Compute environment parameter validation failed.
InvalidParameterValue.DependenceNotFoundTaskName	The dependent task definition was not found.
InvalidParameterValue.DependenceUnfeasible	Loop task dependency is prohibited.
InvalidParameterValue.LocalPath	Invalid local storage path.
InvalidParameterValue.MaxRetryCount	The number of retries is too large.
InvalidParameterValue.Negative	Invalid negative parameter.
InvalidParameterValue.RemoteStoragePath	Invalid storage path format.
InvalidParameterValue.RemoteStorageSchemeType	Invalid storage type.
LimitExceeded.TaskTemplateQuota	Insufficient task template quota.

Recent Pages