Creates a flow.
Operation description
Usage notes
- The number of flows that each user can create is restricted by resources. For more information, see Limits . If you want to create more flows, submit a ticket.
- At the user level, flows are distinguished by name. The name of a flow within one account must be unique.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | string | Yes | The name of the flow. The name is unique within the same region and cannot be modified after the flow is created. Set this parameter based on the following rules:
| flow |
| Definition | string | Yes | The definition of the flow. The definition must comply with the flow definition language (FDL) syntax. Considering compatibility, the system supports two flow definition specifications. | version: v1.0<br/>type: flow<br/>steps:<br/> - type: pass<br/> name: mypass |
| Description | string | Yes | The description of the flow. | test flow |
| Type | string | Yes | The type of the flow. Set this parameter to FDL. | FDL |
| RoleArn | string | No | The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, CloudFlow assumes the role to call API operations of relevant services. | acs:ram:${region}:${accountID}:${role} |
| ExternalStorageLocation | string | No | The path of the external storage. | /path |
| ExecutionMode | string | No | The execution mode. Valid values: Express and Standard. Considering compatibility, an empty string is equivalent to the Standard execution mode. | Standard |
Response parameters
Examples
Sample success responses
JSONformat
{
"Type": "FDL",
"Definition": "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass",
"RoleArn": "acs:ram:${region}:${accountID}:${role}",
"RequestId": "testRequestID",
"Description": "test flow",
"Name": "flow",
"CreatedTime": "2019-01-01T01:01:01.001Z",
"LastModifiedTime": "2019-01-01T01:01:01.001Z",
"Id": "e589e092-e2c0-4dee-b306-3574ddfdddf5****",
"ExecutionMode": "Standard"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 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). | The payload size exceeds maximum allowed size (%s bytes). |
| 400 | InvalidArgument | Parameter error. | Parameter error. |
| 400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | The HTTP header '%s' must be specified. |
| 400 | MissingRequiredParams | The HTTP query '%s' must be specified. | The HTTP query '%s' must be specified. |
| 403 | AccessDenied | The resources doesn't belong to you. | - |
| 403 | InvalidAccessKeyID | The AccessKey ID %s is invalid. | The AccessKey ID %s is invalid. |
| 403 | RequestTimeTooSkewed | The difference between the request time %s and the current time %s is too large. | 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. | The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm. |
| 409 | FlowAlreadyExists | Flow %s already exists. | Flow %s already exists. |
| 415 | UnsupportedMediaType | The content type must be "application/json". | The content type must be "application/json". |
| 429 | ResourceThrottled | The request is throttled. Please try again later. | The request is throttled. Please try again later. |
| 500 | InternalServerError | An internal error has occurred. Please retry. | An internal error has occurred. Please retry. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-03-20 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||||||||
| ||||||||||||||||||||||
| 2023-08-29 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||||||||||||
|