文档

StartSyncExecution - 同步调用开始一个流程的执行

更新时间:

同步调用开始一个流程的执行。

接口说明

  • 仅支持 Express 执行模式的流程。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
FlowNamestring

开始执行的流程名称。

my_flow_name
ExecutionNamestring

执行名称。取值说明如下:

  • 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。
  • 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。
  • 区分大小写。
  • 长度为 1~128 个字符。

不同于 StartExecution 接口,考虑到同步调用的特殊性,在同步执行模式下,不再要求执行名称在同一流程内唯一,调用侧可以选择提供执行名称,对本次执行进行标识,系统会在当前执行名称后添加 UUID,具体形式如 {ExecutionName}:{UUID},如果用户没有指定相关的执行名称信息,那么系统会自动生成标识本次执行的 ExecutionName。

my_exec_name
Inputstring

执行的输入,为 JSON 对象格式。

{"key":"value"}

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

testRequestId
FlowNamestring

流程名称。

my_flow_name
Namestring

流程执行名称。

my_exec_name:{UUID}
Statusstring

执行状态。取值说明如下:

  • Starting
  • Running
  • Stopped
  • Succeeded
  • Failed
  • TimedOut
Succeeded
ErrorCodestring

执行错误时的错误码。

ActionNotSupported
ErrorMessagestring

执行超时。

Standard execution is not supported
Outputstring

执行的输出,为 JSON 对象格式。

{"key":"value"}
StartedTimestring

执行开始时间。

2019-01-01T01:01:01.001Z
StoppedTimestring

执行停止时间。

2019-01-01T01:01:01.001Z

示例

正常返回示例

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错误码错误信息描述
400EntityTooLargeThe payload size exceeds maximum allowed size (%s bytes).请求消息体过大。
400ExecutionAlreadyExistsExecution %s for flow %s already exists.对应流程下已存在同名执行。
400InvalidArgumentParameter error.请求参数错误。具体内容请参考实际错误信息。
400MissingRequiredHeaderThe HTTP header '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
400MissingRequiredParamsThe HTTP query '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
400ActionNotSupportedThe requested API operation %s is incorrect. Please check.所请求方法错误。请参照API文档并检查拼写。
400APIVersionNotSupportedThe requested API version %s is not supported yet. Please check.所请求接口版本不正确。请参考API简介。
403InvalidAccessKeyIDThe AccessKey ID %s is invalid.AccessKey ID无效。
403RequestTimeTooSkewedThe difference between the request time %s and the current time %s is too large.您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。
403SignatureNotMatchThe request signature we calculated does not match the signature you provided. Check your access key and signing method.您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。
403AccessDeniedThe resources does not belong to you.请求鉴权未通过,具体内容请参考实际错误信息。
404FlowNotExistsFlow %s does not exist.所请求资源不存在,请确保流程已创建。
415UnsupportedMediaTypeThe content type must be "application/json".请求消息体类型错误。
429ResourceThrottledThe request is throttled. Please try again later.因某些原因系统流量已达瓶颈。请稍后重试。
500InternalServerErrorAn internal error has occurred. Please retry.服务器内部错误。请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:415
    删除错误码:429
    删除错误码:500
入参OpenAPI 入参发生变更
    删除入参:RequestId