All Products
Search
Document Center

CloudFlow:CreateFlowAlias

Last Updated:Oct 27, 2025

Creates an alias for a flow. You can then use the alias to start an execution.

Operation description

API description

  • The number of flows that you can create is limited by resources. For more information, see Limits. If you have special requirements, you can submit a ticket to request an adjustment.

  • Each flow must have a unique name within your account.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

FlowName

string

Yes

The flow name.

example-flow-name

Name

string

Yes

The alias name.

example-alias-name

Description

string

No

The alias description.

example description

RoutingConfigurations

array<object>

Yes

The traffic distribution configuration for one or two flow versions. When you start an execution using the alias, the system uses the specified weights to select a flow version to execute.

object

No

Version

string

Yes

The flow version.

1

Weight

integer

Yes

The weight.

30

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

testRequestID

FlowName

string

The flow name.

example-flow-name

Name

string

The alias name.

exampe-alias-name

Description

string

The alias description.

example description

RoutingConfigurations

array<object>

The traffic distribution configuration for one or two flow versions. When you start an execution using the alias, the system uses the specified weights to select a flow version to execute.

object

Version

string

The flow version.

1

Weight

integer

The weight.

30

CreatedTime

string

The time when the alias was created.

2020-01-01T01:01:01.001Z

Examples

Success response

JSON format

{
  "RequestId": "testRequestID",
  "FlowName": "example-flow-name",
  "Name": "exampe-alias-name",
  "Description": "example description",
  "RoutingConfigurations": [
    {
      "Version": "1",
      "Weight": 30
    }
  ],
  "CreatedTime": "2020-01-01T01:01:01.001Z"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.