tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateTaskFromTemplate

Last updated: 2024-09-25 10:28:09

1. API Description

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

This API is used to create an experiment using a template.

A maximum of 10 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: CreateTaskFromTemplate.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region No String Common Params. This parameter is not required.
TemplateId Yes Integer Template ID retrieved from the template library
TaskConfig Yes TaskConfig Experiment configuration parameters

3. Output Parameters

Parameter Name Type Description
TaskId Integer ID of the successfully created experiment
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating Experiments by Using Templates

This example shows you how to generate regular experiments for continuous use by using created templates.

Input Example

POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTaskFromTemplate
<Common request parameters>



{
    "TemplateId": 689,
    "TaskConfig": {
        "TaskTitle": "Testing experiment, with instances associated and experiment name and custom action parameters of the first action in the first action group modified",
        "TaskGroupsConfig": [
            {
                "TaskGroupInstances": [
                    "ins-xxxxxxxx"
                ],
                "TaskGroupActionsConfig": [
                    {
                        "TaskGroupActionOrder": 1,
                        "TaskGroupActionCustomConfiguration": "{\"timeout\":200,\"percentage\":80}"
                    }
                ]
            }
        ]
    }
}

Output Example

{
    "Response": {
        "RequestId": "f0aee8ac-2ed3-4a7f-a25b-f0d7d228dd30",
        "TaskId": 50
    }
}

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
AuthFailure CAM signature/authentication error.
AuthFailure.UnauthorizedOperation Unauthorized CAM operation.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
LimitExceeded The quota limit is exceeded.
UnknownParameter Unknown parameter.
UnsupportedOperation The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy