Executing a Flow Asynchronously
Function
This API is used to execute a flow asynchronously. It is available only in the Chinese mainland regions.
URI
POST /v2/{project_id}/fgs/workflows/{workflow_id}/executions
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. For details, see Obtaining a Project ID. Minimum: 1 Maximum: 64 |
workflow_id | Yes | String | Flow definition ID. Minimum: 1 Maximum: 512 |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Create-Time | No | String | workflowRun task create time |
X-WorkflowRun-ID | No | String | workflowRun id |
X-WorkflowRun-MergeFnParameters | No | String | Combines the output of the previous node with the input of the next node into an input. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
headers | No | Object | Headers for flow execution. |
input | Yes | Object | Input parameters for flow execution. You can use JSONPath for parameter mapping and specify a default value. |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
execution_id | String | Error code. Minimum: 1 Maximum: 64 |
Status code: 400
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code. Minimum: 1 Maximum: 36 |
error_msg | String | Error description. Minimum: 2 Maximum: 512 |
Status code: 404
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code. Minimum: 1 Maximum: 36 |
error_msg | String | Error description. Minimum: 2 Maximum: 512 |
Status code: 500
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code. Minimum: 1 Maximum: 36 |
error_msg | String | Error description. Minimum: 2 Maximum: 512 |
Example Requests
Execute a flow.
POST /v2/{project_id}/fgs/workflows/{workflow_id}/executions
{
"headers" : {
"tenantId" : "user1"
},
"input" : {
"arg1" : "argument_1",
"arg2" : "argument_2"
}
} Example Responses
Status code: 200
Success
{
"execution_id" : "48aff955-ea10-4ffd-b426-190bc192dc14"
} Status Codes
Status Code | Description |
|---|---|
200 | Success |
400 | Bad Request |
404 | Bad Request |
500 | Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
