ModifyTaskTemplate

Last updated: 2020-03-06 20:50:25

1. API Description

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

This API is used to modify a task template.

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

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: ModifyTaskTemplate.
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.
TaskTemplateId Yes String Job template ID
TaskTemplateName No String Job template name
TaskTemplateDescription No String Job template description
TaskTemplateInfo No Task Job template information

3. Output Parameters

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

4. Example

Example1 Modify Task Templates

Input Example

https://batch.tencentcloudapi.com/?Action=ModifyTaskTemplate
&TaskTemplateId=task-tmpl-606i415o
&TaskTemplateName=A
&TaskTemplateDescription=test
&TaskTemplateInfo.TaskName=A
&TaskTemplateInfo.TaskInstanceNum=1
&TaskTemplateInfo.Application.DeliveryForm=LOCAL
&TaskTemplateInfo.Application.Command=python -c "fib=lambda n:1 if n<=2 else fib(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.cos.ap-guangzhou.myqcloud.com/hello2/logs/
&TaskTemplateInfo.RedirectInfo.StderrRedirectPath=cos://bucket-appid.ap-guangzhou.myqcloud.com/hello2/logs/
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "8a56bd93-688e-41c3-bc8b-f9867ffb0dd0"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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

Command Line Interface

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
InvalidParameter.CvmParameters Invalid CVM parameter.
InvalidParameter.TaskName Invalid job name.
InvalidParameter.TaskNameTooLong The task name is too long.
InvalidParameter.TaskTemplateDescriptionTooLong The task template description is too long.
InvalidParameter.TaskTemplateIdMalformed Invalid task template ID format.
InvalidParameter.TaskTemplateName Invalid task template name.
InvalidParameter.TaskTemplateNameTooLong The task template name is too long.
InvalidParameterAtLeastOneAttribute At least one of TaskTemplateName, TaskTemplateDescription, and TaskTemplateInfo must be contained.
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.
ResourceNotFound.TaskTemplate The specified job template ID does not exist.