tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyTaskTemplate

Last updated: 2023-05-04 15:47:06

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.

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 Params. The value used for this API: ModifyTaskTemplate.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
TaskTemplateId Yes String Task template ID
TaskTemplateName No String Task template name
TaskTemplateDescription No String Task template description
TaskTemplateInfo No Task Task 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 Modifying a task template

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

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 ComputeEnv and EnvId cannot be both specified.
InternalError Internal error.
InvalidParameter.CvmParameters Invalid CVM parameter.
InvalidParameter.TaskName Invalid task 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 specified.
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 Too many retry attempts
InvalidParameterValue.Negative Invalid negative parameter.
InvalidParameterValue.RemoteStoragePath Invalid storage path format.
InvalidParameterValue.RemoteStorageSchemeType Invalid storage type.
ResourceNotFound.TaskTemplate The specified task template ID does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy