StartExecution_云工作流_API文档

2019-03-15

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

流程必须已经存在，当前仅支持 Standard 执行模式的流程。
如果没有指定执行名称，则服务会自动生成执行名称并开始执行。
如果有同名执行正在进行，则不会开始新的执行，直接返回正在进行中的同名执行。
如果同名执行已经结束（成功或者失败），则会返回ExecutionAlreadyExists。
如果没有同名执行，则开始新的执行。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

fnf:StartExecution	Update	全部资源 *	无	无

请求参数

字段名称	字段详情
FlowNamestring	开始执行的流程名称。示例值:my_flow_name
ExecutionNamestring	执行名称，在同一流程内唯一。取值说明如下：展开详情示例值:my_exec_name
Inputstring	执行的输入，为 JSON 对象格式。示例值:{"key":"value"}
CallbackFnFTaskTokenstring	流程执行结束后回调 TaskToken 相关任务。示例值:12

返回参数

字段名称	字段详情
Statusstring	执行状态。取值说明如下：展开详情示例值:Succeeded
StoppedTimestring	执行停止时间。示例值:2019-01-01T01:01:01.001Z
RequestIdstring	请求 ID。示例值:testRequestId
StartedTimestring	执行开始时间。示例值:2019-01-01T01:01:01.001Z
FlowDefinitionstring	执行的流程定义。示例值:旧版： "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" 新版： "Type: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n - Type: Pass\n Name: my_state\n End: true"
Outputstring	执行的输出，为 JSON 对象格式。示例值:{"key":"value"}
FlowNamestring	流程名称。示例值:my_flow_name
Namestring	执行名称。示例值:my_exec_name
Inputstring	执行的输入，为 JSON 对象格式。示例值:{"key":"value"}

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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).	诊断
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.	诊断
403	AccessDenied	The resources doesn't belong to you.	诊断
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	诊断
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.	诊断
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	删除请求参数RequestId
	2022-02-24	变更返回参数

相关示例