同步調用開始一個流程的執行。
接口說明
- 僅支持 Express 執行模式的流程。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| FlowName | string | 是 | 開始執行的流程名稱。 | my_flow_name |
| ExecutionName | string | 否 | 執行名稱。取值說明如下：
不同于 StartExecution 接口，考慮到同步調用的特殊性，在同步執行模式下，不再要求執行名稱在同一流程內唯一，調用側可以選擇提供執行名稱，對本次執行進行標識，系統會在當前執行名稱后添加 UUID，具體形式如 {ExecutionName}:{UUID}，如果用戶沒有指定相關的執行名稱信息，那么系統會自動生成標識本次執行的 ExecutionName。 | my_exec_name |
| Input | string | 否 | 執行的輸入，為 JSON 對象格式。 | {"key":"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"
}錯誤碼
| 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簡介。 |
| 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. | 因某些原因系統流量已達瓶頸。請稍后重試。 |
| 500 | InternalServerError | An internal error has occurred. Please retry. | 服務器內部錯誤。請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-03-21 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 看變更集 | ||||||||||||||||||
|