同步调用开始一个流程的执行。
接口说明
仅支持 Express 执行模式的流程。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
fnf:StartSyncExecution |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| FlowName |
string |
是 |
开始执行的流程名称。 |
my_flow_name |
| ExecutionName |
string |
否 |
执行名称。取值说明如下：
不同于 StartExecution 接口，考虑到同步调用的特殊性，在同步执行模式下，不再要求执行名称在同一流程内唯一，调用侧可以选择提供执行名称，对本次执行进行标识，系统会在当前执行名称后添加 UUID，具体形式如 {ExecutionName}:{UUID}，如果用户没有指定相关的执行名称信息，那么系统会自动生成标识本次执行的 ExecutionName。 |
my_exec_name |
| Input |
string |
否 |
执行的输入，为 JSON 对象格式。 |
{"key":"value"} |
| Qualifier |
string |
否 |
指定流程版本或别名 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
testRequestId |
| FlowName |
string |
流程名称。 |
my_flow_name |
| Name |
string |
流程执行名称。 |
my_exec_name:{UUID} |
| Status |
string |
执行状态。取值说明如下：
|
Succeeded |
| ErrorCode |
string |
执行错误时的错误码。 |
ActionNotSupported |
| ErrorMessage |
string |
执行超时。 |
Standard execution is not supported |
| Output |
string |
执行的输出，为 JSON 对象格式。 |
{"key":"value"} |
| StartedTime |
string |
执行开始时间。 |
2019-01-01T01:01:01.001Z |
| StoppedTime |
string |
执行停止时间。 |
2019-01-01T01:01:01.001Z |
| Environment |
object |
Flow 执行时使用的环境变量列表 |
|
| Variables |
array<object> |
Flow 执行时使用的环境变量列表 |
|
|
object |
Flow 执行期间可以访问的变量列表 |
||
| Name |
string |
变量名称 |
key |
| Value |
string |
变量值 |
value |
示例
正常返回示例
JSON格式
{
"RequestId": "testRequestId",
"FlowName": "my_flow_name",
"Name": "my_exec_name:{UUID}",
"Status": "Succeeded",
"ErrorCode": "ActionNotSupported",
"ErrorMessage": "Standard execution is not supported",
"Output": "{\"key\":\"value\"}",
"StartedTime": "2019-01-01T01:01:01.001Z",
"StoppedTime": "2019-01-01T01:01:01.001Z",
"Environment": {
"Variables": [
{
"Name": "key",
"Value": "value"
}
]
}
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | EntityTooLarge | The payload size exceeds maximum allowed size (%s bytes). | 请求消息体过大。 |
| 400 | ExecutionAlreadyExists | Execution %s for flow %s already exists. | 对应流程下已存在同名执行。 |
| 400 | InvalidArgument | Parameter error. | 请求参数错误。具体内容请参考实际错误信息。 |
| 400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | 请求所需参数缺失。具体内容请参考实际错误信息。 |
| 400 | MissingRequiredParams | The HTTP query '%s' must be specified. | 请求所需参数缺失。具体内容请参考实际错误信息。 |
| 400 | ActionNotSupported | The requested API operation %s is incorrect. Please check. | 所请求方法错误。请参照API文档并检查拼写。 |
| 400 | APIVersionNotSupported | The requested API version %s is not supported yet. Please check. | 所请求接口版本不正确。请参考API简介。 |
| 500 | InternalServerError | An internal error has occurred. Please retry. | 服务器内部错误。请稍后重试。 |
| 403 | InvalidAccessKeyID | The AccessKey ID %s is invalid. | AccessKey ID无效。 |
| 403 | RequestTimeTooSkewed | The difference between the request time %s and the current time %s is too large. | 您的请求时间不正确，该请求已被识别为无效。请参考通用参数一节。 |
| 403 | SignatureNotMatch | The request signature we calculated does not match the signature you provided. Check your access key and signing method. | 您发起请求的签名与我们计算不一致，请检查您的签名算法及AccessKey Secret。 |
| 403 | AccessDenied | The resources does not belong to you. | 请求鉴权未通过，具体内容请参考实际错误信息。 |
| 404 | FlowNotExists | Flow %s does not exist. | 所请求资源不存在，请确保流程已创建。 |
| 415 | UnsupportedMediaType | The content type must be "application/json". | 请求消息体类型错误。 |
| 429 | ResourceThrottled | The request is throttled. Please try again later. | 因某些原因系统流量已达瓶颈。请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。