CreateFlow_云工作流_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.

接口说明

每个用户所能创建的流程个数受资源限制（详见使用限制），如果您有特殊需求，可以提工单进行调整。
流程在用户级别是按照名称来区分的，即单一账号下不可以存在同名流程。

流控信息

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

授权信息

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

具体说明如下：展开详情

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

fnf:CreateFlow	Create	Flow acs:fnf:{#regionId}:{#accountId}:flow/*	无	无

请求参数

字段名称	字段详情
Namestring	流程名称。该名称在同一地域内唯一，创建后不可修改。取值说明如下：展开详情示例值:my_flow_name
Definitionstring	流程定义，遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。展开详情示例值:旧版： " type: flow version: v1 name: my_flow_name steps: - type: pass name: mypass " 新版： " Type: StateMachine SpecVersion: v1 Name: my_flow_name StartAt: my_state States: - Type: Pass Name: my_state End: true "
Descriptionstring	流程描述。示例值:my test flow
Typestring	流程类型，取值：FDL。示例值:FDL枚举值:FDL
RoleArnstring	流程执行依赖的授权角色资源描述符信息。用于在执行流程时，Serverless 工作流服务扮演该角色（AssumeRole）操作相关的流程资源。示例值:acs:ram:${region}:${accountID}:${role}
ExternalStorageLocationstring	外部存储位置。示例值:/path
ExecutionModestring	执行模式，枚举类型，可以是 Express 和 Standard；考虑到向前兼容，空串等价于 Standard 执行模式。示例值:Standard枚举值:ExpressStandard

返回参数

字段名称	字段详情
Typestring	流程类型。示例值:FDL枚举值:FDL
Definitionstring	流程定义，考虑到向前兼容，当系统支持两种规范的流程定义规范。示例值:旧版： "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"
RoleArnstring	流程执行依赖的授权角色资源描述符信息。用于在执行流程时，Serverless 工作流服务扮演该角色（AssumeRole）操作相关的流程资源。示例值:acs:ram:${region}:${accountID}:${role}
RequestIdstring	请求 ID。当有`http status code`返回时，Serverless 工作流都会返回请求 ID。示例值:testRequestID
Descriptionstring	流程描述信息。示例值:my test flow
Namestring	流程名称。示例值:my_flow_name
CreatedTimestring	流程创建时间。示例值:2019-01-01T01:01:01.001Z
LastModifiedTimestring	流程最近一次的更改时间。示例值:2019-01-01T01:01:01.001Z
Idstring	流程的唯一标识。示例值:e589e092-e2c0-4dee-b306-3574ddfdddf5****
ExecutionModestring	执行模式，枚举类型，可以是 Express 和 Standard，考虑到向前兼容，该字段可能为空字符串，这种情况等价于 Standard 模式。示例值:Standard

返回示例

错误码

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

全局错误码

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	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.	诊断
409	FlowAlreadyExists	Flow %s already exists.	诊断
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-20	删除请求参数RequestId
	2023-08-29	新增请求参数ExecutionMode 变更返回参数
	2022-02-24	变更返回参数

相关示例