tencent cloud

文档反馈

CreateTaskFromAction

最后更新时间:2024-09-25 10:28:11

1. API Description

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

This API is used to create an experiment with an action.

A maximum of 20 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: CreateTaskFromAction.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region No String Common Params. This parameter is not required.
TaskActionId Yes Integer Action ID, which can be obtained by using the action list API DescribeActionLibraryList.
TaskInstances.N Yes Array of String ID of the instance participating in the experiment.
TaskTitle No String Experiment name. If this parameter is left blank, the action name is used by default.
TaskDescription No String Experiment description. If this parameter is left blank, the action description is used by default.
TaskActionGeneralConfiguration No String General action parameters, which need to be passed in after JSON serialization. The parameters can be obtained by using the action details API DescribeActionFieldConfigList. If this field is left blank, the default action parameters are used by default.
TaskActionCustomConfiguration No String Action custom parameters need to be passed in as json serialization. They can be obtained from the action details interface DescribeActionFieldConfigList. If not filled in, the default action parameters will be used. Note: Required parameters have no default values. Be sure to pass in valid values.
TaskPauseDuration No Integer Automatic experiment pause time, in minutes. If this parameter is left blank, the default value 60 is used.

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 an Experiment with Actions

Input Example

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









{
    "TaskActionId": 127,
    "TaskInstances": [
        "ins-87bfr32q"
    ]

}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.