API standards and multilingual preset SDKs
The OpenAPI of this product (fnf/2019-03-15) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Flow
|
API |
Title |
Description |
| DescribeFlow | DescribeFlow | Retrieves information about a flow. |
| Flow alias | Flow alias | |
| ListFlowAliases | ListFlowAliases | Lists the aliases for a flow. |
| CreateFlowAlias | CreateFlowAlias | Creates an alias for a flow. You can then use the alias to start an execution. |
| DescribeFlowAlias | DescribeFlowAlias | Queries the details of a flow alias. |
| UpdateFlowAlias | UpdateFlowAlias | Updates the alias configuration for a flow. |
| DeleteFlowAlias | DeleteFlowAlias | Deletes a flow alias. |
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. |
| DescribeMapRun | DescribeMapRun | Retrieves the details of a MapRun. |
| UpdateMapRun | UpdateMapRun | Updates the configuration of a MapRun. |
Task
|
API |
Title |
Description |
| ReportTaskFailed | ReportTaskFailed | Reports a failed task. |
| ReportTaskSucceeded | ReportTaskSucceeded | Reports a successful task. |
Timed scheduling
|
API |
Title |
Description |
| CreateSchedule | CreateSchedule | Creates a timed 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. |
Other
|
API |
Title |
Description |
| CreateFlow | CreateFlow | Creates a flow. |
| DeleteFlow | DeleteFlow | Deletes an existing flow. |
| DeleteFlowVersion | DeleteFlowVersion | Deletes a flow version. |
| DescribeRegions | Query region information | Queries the regions supported by CloudFlow. |
| ListFlows | ListFlows | Retrieves information about multiple flows. |
| ListFlowVersions | ListFlowVersions | Lists the versions of a flow. |
| ListSchedules | ListSchedules | Queries time-based schedules in 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. |
| UpdateFlow | UpdateFlow | Updates the content of a flow. |