Domain name for API request: databuddy.intl.tencentcloudapi.com.
Runs the workflow
A maximum of 20 requests can be initiated per second for this API.
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: RunWorkflow. |
| Version | Yes | String | Common Params. The value used for this API: 2026-07-15. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| WorkspaceId | Yes | String | Workspace ID, which can be obtained through ListWorkspaces. Required |
| WorkflowId | Yes | String | Workflow ID, which can be obtained through ListWorkflows. Required |
| RunType | Yes | Integer | Running type. Required. Value: 1 ordinary, 2 advanced running |
| AdvancedParams.N | No | Array of TaskSchedulingParameterBrief | Custom running parameter filled in when the running type is advanced running |
| TaskIds.N | No | Array of String | This time, the specified task ID set needs to be run, which can be obtained through ListWorkflowTasks. If not passed, all tasks under the workflow run by default. |
| IdempotencyToken | No | String | Idempotency token. Optional. Duplicate requests with the same token trigger only once |
| ScheduledTimeConfig | No | ScheduledTimeConfig | Scheduled dispatch time list configuration |
| Parameter Name | Type | Description |
|---|---|---|
| Data | AsyncActionRsp | Run workflow response content |
| 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. |
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunWorkflow
<Common request parameters>
{
"WorkspaceId": "17697410068842890",
"WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
"RunType": 1
}{
"Response": {
"Data": {
"ActionResults": [
{
"ErrorMessage": "",
"OpStatus": true,
"RunActionId": "cmd_20260807195442_000001",
"WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1_1786103682348",
"WorkflowName": "new_workflow_20260807_190451",
"WorkflowRunId": ""
}
]
},
"RequestId": "5e78212a-8c5b-444f-a493-f64b563d707c"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| FailedOperation.CallThirdPartApiError | Failed to call the <apiName> API of the <serviceName> service: <message>. |
| FailedOperation.RunWorkflowFail | Failed to run workflow |
| FailedOperation.RunWorkflowFailExecutionIdEmpty | The execution ID returned by running the workflow is empty. |
| FailedOperation.WorkflowNoPermission | No operation permissions. |
| InternalError | Internal error. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameterValue.InvalidParameter | Parameter error. |
| InvalidParameterValue.ParamBlankError | Parameter <parameter> cannot be empty. |
| InvalidParameterValue.ParamIllegalError | Parameter <parameter> does not meet requirements: <message> |
| InvalidParameterValue.ParamNullError | Parameter <parameter> cannot be null. |
| MissingParameter | Parameters are missing. |
| ResourceNotFound.WorkflowNotExist | Workflow does not exist. |
| ResourceNotFound.WorkflowTaskNotExist | The task in the workflow does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback