CreateTriggerWorkflowRun

Last updated:2026-03-13 12:14:16

CreateTriggerWorkflowRun

Last updated: 2026-03-13 12:14:16

1. API Description

Domain name for API request: wedata.intl.tencentcloudapi.com.

Run workflow under workflow scheduling model.

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: CreateTriggerWorkflowRun.
Version	Yes	String	Common Params. The value used for this API: 2025-08-06.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ProjectId	Yes	String	Project ID.
WorkflowId	Yes	String	Workflow ID.
AdvancedParams.N	No	Array of SchedulingParameter	Custom running parameters. if empty or null, use the latest configuration of the workflow.
TaskIds.N	No	Array of String	This time, run the specified task ID set. if it is null or empty, run all.
SchedulingResourceGroupId	No	String	Specified scheduling resource group id. uses the original resource group by default if left empty.
IntegrationResourceGroupId	No	String	Specified integration resource group id. uses the original resource group if left empty.

3. Output Parameters

Parameter Name	Type	Description
Data	CreateTriggerWorkflowRunResult	Operation Result Information Note: This field may return null, indicating that no valid values can be obtained.
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 Execute Workflow with Custom Parameters

Input Example

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

{
    "ProjectId": "3126203***945134080",
    "WorkflowId": "9f551833-215***772-8ec1-78019779617c",
    "AdvancedParams": [
        {
            "ParamKey": "k1",
            "ParamValue": "k2"
        }
    ],
    "TaskIds": [
        "202601***53102448"
    ],
    "SchedulingResourceGroupId": "2026010***5230846836",
    "IntegrationResourceGroupId": "2025062***2930469737"
}

Output Example

{
    "Response": {
        "Data": {
            "WorkflowExecutionId": "74fe7410-a820-42ea-80ea-06eb793d06c2"
        },
        "RequestId": "164284d1-4205-4883-bcff-2c1ee5f38764"
    }
}

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
FailedOperation	Operation failed.
InternalError	Internal error.
InternalError.UnknownError	Unknown error.
InvalidParameter	Parameter error.
InvalidParameterValue	Parameter value error.
InvalidParameterValue.ParamIllegalError	Invalid parameter.
MissingParameter	Parameter missing.
ResourceNotFound	The resource does not exist.
UnauthorizedOperation	Unauthorized operation.
UnknownParameter	Unknown parameter error.
UnsupportedOperation	The operation is not supported.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud