# Alibaba Cloud CloudFlow API

> Alibaba Cloud CloudFlow API on Apizie: 30 endpoints (Creates a flow, Creates an alias for a flow. You can specify the alias when initiating an execution, Creates a timed schedule, Deletes an existing flow, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-fnf/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-fnf`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/fnf
- Page: https://www.apizie.tech/api/cloud/aliyun-fnf
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-fnf/openapi.json

Alibaba Cloud OpenAPI for CloudFlow (fnf, version 2019-03-15). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a flow
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/create-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| Name | string | yes | The name of the flow. The name must be unique within the same region and cannot be changed after the flow is created. The name must meet… |
| Definition | string | yes | The definition of the flow. It must comply with the Flow Definition Language (FDL) syntax. For forward compatibility, the system supports… |
| Description | string | yes | The description of the flow |
| Type | string | yes | The type of the flow. The value must be FDL |
| RoleArn | string | no | The resource descriptor for the role that the flow relies on for execution. When the flow runs, Serverless Workflow assumes this role… |
| ExternalStorageLocation | string | no | The external storage location |
| ExecutionMode | string | no | The execution mode. This is an enumeration type. Valid values are Express and Standard. For forward compatibility, an empty string is… |
| Environment | string | no | The environment context that the flow can access during execution (JSON-encoded) |
| ResourceGroupId | string | no | 资源组id |

### Creates an alias for a flow. You can specify the alias when initiating an execution
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/create-flow-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow |
| Name | string | yes | The alias |
| Description | string | no | The description of the alias |
| RoutingConfigurations | string | yes | The routing configurations. You can configure one or two flow versions. When you specify the alias to initiate an execution, the system… |

### Creates a timed schedule
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/create-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the workflow to which the timed schedule is attached |
| ScheduleName | string | yes | The name of the timed schedule. The name must meet the following requirements: It can contain letters (a-z and A-Z), digits (0-9),… |
| Description | string | no | The description of the timed schedule |
| Payload | string | no | The trigger message of the timed schedule. The message must be in the JSON format |
| CronExpression | string | yes | The cron expression |
| Enable | string | no | Specifies whether to enable the timed schedule. Valid values: true: Enables the timed schedule. false: Disables the timed schedule |
| SignatureVersion | string | no | The SignatureVersion |

### Deletes an existing flow
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/delete-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| Name | string | yes | The name of the workflow that you want to delete |

### Deletes a flow alias
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/delete-flow-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow |
| Name | string | yes | The name of the alias |

### Deletes a flow version
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/delete-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow |
| FlowVersion | string | yes | The version of the flow |

### Deletes a time-based scheduling task
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/delete-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the workflow with which the scheduling task that you want to delete is associated |
| ScheduleName | string | yes | The name of the scheduling task that you want to delete |

### Retrieves the status information of an execution. This operation supports long polling, where the maximum…
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/describe-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow |
| ExecutionName | string | yes | The name of the execution |
| WaitTimeSeconds | integer | no | The maximum wait time for a long polling request. Valid values: 0 to 60. Unit: seconds. Valid values: 0: The request immediately returns… |

### Retrieves the details of a flow
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/describe-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| Name | string | yes | The name of the flow |
| FlowVersion | string | no | The version of the flow |

### Queries the details of a flow version alias
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/describe-flow-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow |
| Name | string | yes | The alias |

### Queries the details of a MapRun
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/describe-map-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| RequestId | string | no | The request ID |
| FlowName | string | yes | The flow name |
| ExecutionName | string | yes | The execution name |
| MapRunName | string | yes | The name of the MapRun. When a MapRun execution is initiated within an execution, a MapRunStarted event is generated. You can obtain the… |

### Queries the regions supported by CloudFlow
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| AcceptLanguage | string | no | Filters the returned results by Chinese or English. For more information, see RFC 7231. Valid values: zh-CN: Simplified Chinese. en-US:… |

### Queries the detailed information about a time-based schedule
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/describe-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow that is associated with the time-based schedule. The name must be unique within the region and cannot be modified… |
| ScheduleName | string | yes | The name of the time-based schedule. The name must meet the following conventions: The name can contain letters, digits, underscores (_),… |

### Queries the details about each step in an execution process
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/get-execution-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the workflow |
| ExecutionName | string | yes | The name of the execution |
| NextToken | string | no | The name of the event to start the query. You can obtain the value from the response data |
| Limit | integer | no | The number of workflows that you want to query. Valid values: 1-999. Default value: 60 |

### Retrieves all historical executions of a flow
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/list-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow. The name must be unique within a region and cannot be modified after creation. The name must meet the following… |
| NextToken | string | no | The name from which the execution query starts. You can obtain this value from the response of this operation. This parameter is not… |
| Limit | integer | no | The number of entries to return. Valid values: 1 to 100. Default value: 60 |
| Status | string | no | The execution status used for filtering. Valid values: Starting Running Stopped Succeeded Failed TimedOut |
| StartedTimeBegin | string | no | Filters all executions that started after a specified time. The time must be in UTC and follow the RFC 3339 standard |
| StartedTimeEnd | string | no | Filters all executions that started before a specified time. The time must be in UTC and follow the RFC 3339 standard |
| ExecutionNamePrefix | string | no | The prefix of the execution name |
| MetadataOnly | string | no | Specifies whether to return only the metadata of the execution. If you set this parameter to true, the response does not include the flow… |
| Qualifier | string | no | The version or alias of the flow |
| MapRunName | string | no | The name of the MapRun. After a MapRun execution is initiated in an execution, a MapRunStarted event is generated. You can obtain the… |

### Queries flow version aliases
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/list-flow-aliases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow |
| NextToken | string | no | list token |
| Limit | integer | no | The maximum number of results to return |

### Lists the flow versions
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/list-flow-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The flow name |
| NextToken | string | no | list token |
| Limit | string | no | The maximum number of results to return |

### Lists flow information
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/list-flows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| NextToken | string | no | The name of the flow from which the query starts |
| Limit | integer | no | The number of entries to return. Valid values: 1 to 999. Default value: 60 |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries time-based schedules in a flow
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/list-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow that is associated with the time-based schedules. The name is unique within the region and cannot be modified after… |
| NextToken | string | no | For the first query, you do not need to specify this parameter. The system uses the value of the FlowName parameter as the value of the… |
| Limit | integer | no | The number of schedules that you want to query. Valid values: 1 to 1000 |

### Publishes a new flow version based on the current workflow definition, with the version number incrementing…
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/publish-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow |
| Description | string | no | The description of the version |

### Reports a failed task
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/report-task-failed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| TaskToken | string | yes | The token of the task whose execution you want to report. The task token is passed to the called service, such as Message Service (MNS) or… |
| Error | string | yes | The error code for the failed task. The error code must be 1 to 128 characters in length |
| Cause | string | no | The cause of the failure. The value must be 1 to 4,096 characters in length |

### Reports a successful task
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/report-task-succeeded` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| TaskToken | string | yes | The token of the task whose execution you want to report. The task token is passed to the called service, such as Message Service (MNS) or… |
| Output | string | yes | The output information of the task whose execution success you want to report |

### Starts a flow execution
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/start-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow to execute |
| ExecutionName | string | no | The name of the execution. The name must be unique within the same flow. The name must meet the following requirements: It must start with… |
| Input | string | no | The input for the execution. The input must be in the JSON object format |
| CallbackFnFTaskToken | string | no | The token of a task to be called back after the flow execution is complete |
| Qualifier | string | no | The version or alias of the flow |

### Starts the execution of a flow through a synchronization call
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/start-sync-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow to start |
| ExecutionName | string | no | The name of the execution. The name must meet the following requirements: It can contain letters, digits, underscores (_), and hyphens… |
| Input | string | no | The input of the execution in JSON object format |
| Qualifier | string | no | Specifies the flow version or alias |

### Stops a running flow
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/stop-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow to stop. You can obtain the flow name from the response of the ListFlows operation |
| ExecutionName | string | yes | The name of the execution to stop. You can obtain the execution name from the response of the ListExecutions operation |
| Cause | string | no | The cause of the stop error. The value must be 1 to 4,096 characters in length |
| Error | string | no | The error code for the stop operation. The value must be 1 to 128 characters in length |

### Updates the content of a flow
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/update-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| Name | string | yes | The name of the flow |
| Definition | string | no | The flow definition, which follows the Flow Definition Language (FDL) syntax standard. For forward compatibility, the system supports two… |
| Description | string | no | The description of the flow |
| Type | string | no | The type of the flow. Valid values: FDL |
| RoleArn | string | no | The resource descriptor of the authorized role on which the flow execution depends. When the flow is executed, the flow execution engine… |
| Environment | string | no | The list of variables that can be accessed during flow execution (JSON-encoded) |

### Updates the alias configuration of a flow version
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/update-flow-alias` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow |
| Name | string | yes | The alias |
| Description | string | no | The description of the alias |
| RoutingConfigurations | string | no | The weight configuration (JSON-encoded) |

### Updates the configuration of a MapRun
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/update-map-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| RequestId | string | no | Request ID |
| FlowName | string | yes | Name of the flow |
| ExecutionName | string | yes | Name of the execution |
| MapRunName | string | yes | Name of the MapRun. Retrieve this value from the output of the `MapRunStarted` event |
| Concurrency | integer | no | The concurrency limit for the MapRun runtime. The default quota for a single account is 300. You can request a quota increase in Quota… |
| ToleratedFailedCount | integer | no | The maximum number of failed items that are allowed |
| ToleratedFailedPercentage | number | no | The maximum percentage of failed items that are allowed. Valid range: 0 to 100 |

### Updates a time-based schedule
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/update-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |
| FlowName | string | yes | The name of the flow that is associated with the time-based schedule. The name must be unique within the region and cannot be modified… |
| ScheduleName | string | yes | The name of the time-based schedule. The name must meet the following conventions: The name can contain letters, digits, underscores (_),… |
| Description | string | no | The description of the time-based schedule |
| Payload | string | no | The trigger message of the time-based schedule. It must be in the JSON format |
| CronExpression | string | no | The CRON expression |
| Enable | string | no | Specifies whether to enable the time-based schedule. Valid values: true false |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-fnf/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.fnf.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-fnf/create-flow" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud CloudFlow API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-fnf/create-flow with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud CloudFlow API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud CloudFlow itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud CloudFlow API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-fnf.

### What is the status of the Alibaba Cloud CloudFlow API?
Needs your own provider key (bring your own key)