獲取一次執(zhí)行的狀態(tài)信息,支持長輪詢模式,長輪詢最長等待時(shí)間由 WaitTimeSeconds 參數(shù)指定。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
FlowName | string | 是 | 流程名稱。 | my_flow_name |
ExecutionName | string | 是 | 執(zhí)行名稱。 | my_exec_name |
WaitTimeSeconds | integer | 否 | 請求長輪詢的最長等待時(shí)間。取值范圍[0,60],單位為秒。取值說明如下:
| 20 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Status": "Succeeded",
"StoppedTime": "2019-01-01T01:01:01.001Z",
"RequestId": "testRequestId",
"StartedTime": "2019-01-01T01:01:01.001Z",
"FlowDefinition": "舊版:\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass\"\n\n新版:\n\"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true\"",
"Output": "{\"key\":\"value\"}",
"FlowName": "my_flow_name",
"Name": "my_exec_name",
"Input": "{\"key\":\"value\"}"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InvalidArgument | Parameter error. | 請求參數(shù)錯(cuò)誤。具體內(nèi)容請參考實(shí)際錯(cuò)誤信息。 |
400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | 請求所需參數(shù)缺失。具體內(nèi)容請參考實(shí)際錯(cuò)誤信息。 |
400 | MissingRequiredParams | The HTTP query '%s' must be specified. | 請求所需參數(shù)缺失。具體內(nèi)容請參考實(shí)際錯(cuò)誤信息。 |
400 | ActionNotSupported | The requested API operation '%s' is incorrect. Please check. | - |
400 | APIVersionNotSupported | The requested API version '%s' is not supported yet. Please check. | - |
400 | EntityTooLarge | The payload size exceeds maximum allowed size (%s bytes). | 請求消息體過大。 |
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. | 您的請求時(shí)間不正確,該請求已被識(shí)別為無效。請參考通用參數(shù)一節(jié)。 |
403 | SignatureNotMatch | The request signature we calculated does not match the signature you provided. Check your access key and signing method. | 您發(fā)起請求的簽名與我們計(jì)算不一致,請檢查您的簽名算法及AccessKey Secret。 |
403 | AccessDenied | The resources doesn't belong to you. | - |
404 | ExecutionNotExists | Execution %s for flow %s does not exist. | 所請求資源不存在,請確保流程已創(chuàng)建并存在待查詢的執(zhí)行。 |
404 | FlowNotExists | Flow %s does not exist. | 所請求資源不存在,請確保流程已創(chuàng)建。 |
412 | PreconditionFailed | The resource to be modified has been changed. | 資源查看或更新檢查失敗,該資源可能已被更改。請稍后重試。 |
415 | UnsupportedMediaType | The content type must be "application/json". | 請求消息體類型錯(cuò)誤。 |
429 | ResourceThrottled | The request is throttled. Please try again later. | 因某些原因系統(tǒng)流量已達(dá)瓶頸。請稍后重試。 |
500 | InternalServerError | An internal error has occurred. Please retry. | 服務(wù)器內(nèi)部錯(cuò)誤。請稍后重試。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-03-21 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 看變更集 | ||||||||||||||||||||
|