同步調用開始一個流程的執行。
介面說明
僅支援 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. | 因某些原因系統流量已達瓶頸。請稍後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。