调用StartExecution开始一个流程执行。
接口说明
- 流程必须已经存在。
- 如果没有指定执行名称,则服务会自动生成执行名称并开始执行。
- 如果有同名执行正在进行,则不会开始新的执行,直接返回正在进行中的同名执行。
- 如果同名执行已经结束(成功或者失败),则会返回ExecutionAlreadyExists。
- 如果没有同名执行,则开始新的执行。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StartExecution |
系统规定参数。取值:StartExecution。 |
FlowName | String | 是 | flow |
开始执行的流程名称。 |
RequestId | String | 否 | testRequestId |
如果您指定了该值,系统将使用该值作为本次请求的ID。默认系统会随机生成。 |
ExecutionName | String | 否 | exec |
自定义执行的名称,如需输入请保证该流程下唯一。 |
Input | String | 否 | {} |
本次执行的输入信息。 |
CallbackFnFTaskToken | String | 否 | 12 |
流程执行结束后回调TaskToken相关任务。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
FlowDefinition | String | version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass |
执行的流程定义。 |
FlowName | String | flow |
流程名称。 |
Input | String | empty string |
执行的输入。 |
Name | String | exec1 |
执行名称。 |
Output | String | empty string |
执行的输出。 |
RequestId | String | testRequestId |
本次请求ID。 |
StartedTime | String | 2019-01-01T01:01:01.001Z |
执行开始时间。 |
Status | String | empty string |
执行的状态。 |
StoppedTime | String | 2019-01-01T01:01:01.001Z |
执行停止时间。 |
示例
请求示例
http(s)://[Endpoint]/?Action=StartExecution
&FlowName=flow
&<公共请求参数>
正常返回示例
XML
格式
<CreateFlowResponseponse>
<Description>Response in XML format is not supported.</Description>
</CreateFlowResponseponse>
JSON
格式
{
"Name": "exec1",
"FlowName": "flow",
"FlowDefinition": "version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass",
"Input": "",
"Output": "",
"Status": "",
"StartedTime": "2019-01-01T01:01:01.001Z",
"StoppedTime": "2019-01-01T01:01:01.001Z",
"RequestId": "testRequestId"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | AccessDenied | The resources doesn't belong to you. | 请求鉴权未通过,具体内容请参考实际错误信息 |
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简介 |
400 | EntityTooLarge | The payload size exceeds maximum allowed size (%s bytes). | 请求消息体过大 |
400 | ExecutionAlreadyExists | Execution %s for flow %s already exists. | 对应流程下已存在同名执行 |
404 | FlowNotExists | Flow %s does not exist. | 所请求资源不存在,请确保流程已创建。 |
500 | InternalServerError | An internal error has occurred. Please retry. | 服务器内部错误。请稍后重试 |
403 | InvalidAccessKeyID | The AccessKey ID %s is invalid. | access key ID 无效。 |
400 | InvalidArgument | Parameter error. | 请求参数错误。具体内容请参考实际错误信息 |
400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | 请求所需参数缺失。具体内容请参考实际错误信息。 |
400 | MissingRequiredParams | The HTTP query '%s' must be specified. | 请求所需参数缺失。具体内容请参考实际错误信息。 |
403 | RequestTimeTooSkewed | The difference between the request time %s and the current time %s is too large. | 您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。 |
429 | ResourceThrottled | The request is throttled. Please try again later. | 因某些原因系统流量已达瓶颈。请稍后重试。 |
403 | SignatureNotMatch | The request signature we calculated does not match the signature you provided. Check your access key and signing method. | 您发起请求的签名与我们计算不一致,请检查您的签名算法及access key secret。 |
415 | UnsupportedMediaType | The content type must be "application/json". | 请求消息体类型错误。 |
访问错误中心查看更多错误码。
访问错误中心查看更多错误码。