文档

CreateFlow - 创建一个流程

更新时间:

创建一个流程。

接口说明

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

调试

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

授权信息

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

请求参数

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

请求 ID。如果您指定了该值,系统将使用该值作为本次请求的 ID;如果您不指定,系统将随机生成。

testRequestID
Namestring

流程名称。该名称在同一地域内唯一,创建后不可修改。取值说明如下:

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

流程定义,遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容,当系统支持两种规范的流程定义规范。

旧版: "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"
Descriptionstring

流程描述。

my test flow
Typestring

流程类型,取值:FDL

FDL
RoleArnstring

流程执行依赖的授权角色资源描述符信息。用于在执行流程时,Serverless 工作流服务扮演该角色(AssumeRole)操作相关的流程资源。

acs:ram:${region}:${accountID}:${role}
ExternalStorageLocationstring

外部存储位置。

/path
ExecutionModestring

执行模式,枚举类型,可以是 Express 和 Standard;考虑到向前兼容,空串等价于 Standard 执行模式。

Standard

返回参数

名称类型描述示例值
object

返回数据。

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

示例

正常返回示例

JSON格式

{
  "Type": "FDL",
  "Definition": "旧版:\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\"",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}",
  "RequestId": "testRequestID",
  "Description": "my test flow",
  "Name": "my_flow_name",
  "CreatedTime": "2019-01-01T01:01:01.001Z",
  "LastModifiedTime": "2019-01-01T01:01:01.001Z",
  "Id": "e589e092-e2c0-4dee-b306-3574ddfdddf5****",
  "ExecutionMode": "Standard"
}

错误码

HTTP status code错误码错误信息描述
400ActionNotSupportedThe requested API operation '%s' is incorrect. Please check.-
400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
400EntityTooLargeThe payload size exceeds maximum allowed size (%s bytes).请求消息体过大。
400InvalidArgumentParameter error.请求参数错误。具体内容请参考实际错误信息。
400MissingRequiredHeaderThe HTTP header '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
400MissingRequiredParamsThe HTTP query '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
403AccessDeniedThe resources doesn't belong to you.-
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。
409FlowAlreadyExistsFlow %s already exists.已存在同名流程。
415UnsupportedMediaTypeThe content type must be "application/json".请求消息体类型错误。
429ResourceThrottledThe request is throttled. Please try again later.因某些原因系统流量已达瓶颈。请稍后重试。
500InternalServerErrorAn internal error has occurred. Please retry.服务器内部错误。请稍后重试。

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

变更历史

变更时间变更内容概要操作
2023-08-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:409
    删除错误码:415
    删除错误码:429
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:ExecutionMode
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈