API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (fnf/2019-03-15) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Region
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries the regions supported by CloudFlow. |
Flow
|
API |
Title |
Description |
| CreateFlow | CreateFlow | Creates a flow. |
| DeleteFlow | DeleteFlow | Deletes an existing flow. |
| UpdateFlow | UpdateFlow | Updates the content of a flow. |
| DescribeFlow | DescribeFlow | Retrieves information about a flow. |
| ListFlows | ListFlows | Queries a list of flows. |
Execution
|
API |
Title |
Description |
| StartExecution | StartExecution | Starts a flow execution. |
| StopExecution | StopExecution | Stops an execution that is in progress in a flow. |
| DescribeExecution | DescribeExecution | Queries the status of an execution. This operation supports long polling. The WaitTimeSeconds parameter specifies the maximum wait time. |
| ListExecutions | ListExecutions | Lists the execution history of a flow. |
| GetExecutionHistory | GetExecutionHistory | Queries the details about each step in an execution process. |
| StartSyncExecution | StartSyncExecution | Synchronously starts a flow execution. |
Task
|
API |
Title |
Description |
| ReportTaskFailed | ReportTaskFailed | Reports a failed task. |
| ReportTaskSucceeded | ReportTaskSucceeded | Reports a successful task. |
Time-Based Schedules
|
API |
Title |
Description |
| CreateSchedule | CreateSchedule | Creates a time-based schedule. |
| DeleteSchedule | DeleteSchedule | Deletes a time-based scheduling task. |
| UpdateSchedule | UpdateSchedule | Updates a time-based schedule. |
| DescribeSchedule | DescribeSchedule | Queries the detailed information about a time-based schedule. |
| ListSchedules | ListSchedules | Queries time-based schedules in a flow. |
Others
|
API |
Title |
Description |
| CreateFlowAlias | CreateFlowAlias | Creates an alias for a flow. You can then use the alias to start an execution. |
| DeleteFlowAlias | DeleteFlowAlias | Deletes a flow alias. |
| DeleteFlowVersion | DeleteFlowVersion | Deletes a flow version. |
| DescribeFlowAlias | DescribeFlowAlias | Queries the details of a flow alias. |
| ListFlowAliases | ListFlowAliases | Lists the aliases for a flow. |
| ListFlowVersions | ListFlowVersions | Lists the versions of a flow. |
| PublishFlowVersion | PublishFlowVersion | Publishes a new version of a flow based on its current definition. A flow version includes the flow's definition, description, environment variable settings, and execution role. The version number starts at 1 and increments with each new version. |
| UpdateFlowAlias | UpdateFlowAlias | Updates the alias configuration for a flow. |