With normal integration, CloudFlow calls API operations of other Alibaba Cloud services directly through OpenAPI. The API requests and responses pass through without modification, making normal integration compatible with most Alibaba Cloud services across elastic computing, storage, databases, containers, big data, observability, and middleware categories.
How it works
CloudFlow sends an API request to the target service through OpenAPI.
The target service processes the request and returns a response.
CloudFlow captures the response and advances to the next state in the workflow.
Specify each API call using the Action field in the format {ServiceName}:{APIOperation}. For example, ECS:DescribeInstances calls the DescribeInstances operation of Elastic Compute Service (ECS).
Integration modes
The TaskMode parameter controls how CloudFlow handles the API response. The following table describes the available modes.
| Mode | Behavior | Use case |
|---|---|---|
RequestComplete | Waits for the API response before advancing to the next state. | Standard synchronous API calls (most common). |
For other modes and their differences, see the "Integration modes" section of Integration overview.
Prerequisites
Before you begin, make sure that you have:
An Alibaba Cloud account with CloudFlow activated
A Resource Access Management (RAM) execution role with permissions for the target service APIs. For example, calling
ECS:DescribeInstancesrequires theAliyunECSReadOnlyAccesspermissionIf you already have a RAM role, select it when configuring the workflow
To create one, see the "Create an execution role" section in Create execution roles
Create a normal integration workflow
This example calls the ECS DescribeInstances API operation to query instance information.
Step 1: Create a workflow
Log on to the CloudFlow console. In the top navigation bar, select a region.
On the Workflows page, click Create Workflow.
In the Create Workflow dialog box:
Select Use Blank Canvas.
In the Workflow mode section, select a workflow mode.
Set the Workflow Name and Workflow description.
Click Create.
Step 2: Configure the execution role and timeout
On the Workflow Studio graphical interface:
Click the CloudFlow Studio tab and set the Timeout Period.
Click the Configure Workflow tab and set the Execution Role.
Step 3: Add an API action
Add an API action using the visual editor or the YAML editor.
Option A: Visual editor
In the Actions tab of the state view panel, search for
DescribeInstances.Drag the
DescribeInstancesAPI operation onto the flowchart.In the configuration panel on the right, set the Basic Settings, Input Settings, Output Settings, and Troubleshooting parameters.
For parameter details, see the "Procedure" section of Create a workflow based on a blank canvas.
Option B: YAML editor
Click YAML in the upper-right corner and define the API operation directly. The following example queries ECS instances in a specific VPC and vSwitch:
Type: StateMachine
Name: test
SpecVersion: v1
Timeout: 600
StartAt: DescribeInstances
States:
- Type: Task
Name: DescribeInstances
Action: ECS:DescribeInstances
TaskMode: RequestComplete
Parameters:
RegionId: cn-hangzhou
VpcId: vpc-bp11y195luy47h8****
VSwitchId: vsw-bp1wb297ekw7xyh****
End: trueThe following table describes the key parameters.
| Parameter | Description |
|---|---|
Action | API operation to call, in the format {ServiceName}:{APIOperation}. This example uses ECS:DescribeInstances to query ECS instance details. To call this operation, grant the AliyunECSReadOnlyAccess permission to the execution role. |
TaskMode | Integration mode. RequestComplete waits for the API response before advancing to the next state. For other modes, see Integration overview. |
Parameters | Input parameters passed to the target API. These vary by service and API operation. In this example, RegionId, VpcId, and VSwitchId filter the ECS instances to query. Replace these values with your own. |
Step 4: Run the workflow
Click Execute in the upper-right corner.
In the Execute Workflow panel, set the Execution Name and Input of Execution, and then click OK.
After the workflow runs, check the results on the Execution Details page.
Supported services
Normal integration works with most Alibaba Cloud services. The following table lists the supported services by category.
| Category | Services |
|---|---|
| Elastic computing | Function Compute, CloudFlow, Elastic Compute Service, Container Registry, Distributed Cloud Container Platform for Kubernetes, Elastic Container Instance, Serverless App Engine, Web App Service, Elastic Desktop Service, Container Service for Kubernetes, Cloud Phone, Auto Scaling, Elastic Accelerated Computing Instances, Server Migration Center, Resource Orchestration Service, CloudOps Orchestration Service |
| Middleware | EventBridge, ApsaraMQ for RocketMQ 5.0, SchedulerX, Application High Availability Service, ApsaraMQ for MQTT, Service Mesh, Simple Message Queue (formerly MNS), ApsaraMQ for RabbitMQ |
| Storage and CDN | Alibaba Cloud CDN, Object Storage Service, Dynamic Content Delivery Network, Elastic Block Storage, Database File System, Apsara File Storage for HDFS, Apsara File Storage NAS and Cloud Parallel File Storage, Intelligent Media Management, Cloud Backup, Hybrid Disaster Recovery, Edge Node Service |
| Monitoring and management | ActionTrail, Cloud Governance Center, Key Management Service, Service Catalog, Operations Incident Center, Quota Center |
| Application services | API Gateway, CloudESL, Alibaba Cloud DNS PrivateZone, Security Access Service Edge, Blockchain as a Service, IoV Command Center, Intelligent Dual-Recording System, Smart Conversation Analysis, Voice Navigator, Energy Expert, Scalable Open Financial Architecture |
| Database | ApsaraDB for MongoDB, RDS Data API, AnalyticDB for PostgreSQL, ApsaraDB for ClickHouse, ApsaraDB for HBase, ApsaraDB for OceanBase, ApsaraDB RDS, Tair (Redis OSS-compatible), ApsaraDB for Cassandra, ApsaraDB for MyBase, AnalyticDB for MySQL, Data Disaster Recovery |
| Extension | HTTP, Terraform |
| Cloud Gaming | Graphic Computing Service |
| Cloud communications | ChatApp Message Service, Cell Phone Number Service, Artificial Intelligence Cloud Call Service, Direct Mail |
| AI | Automated Machine Learning Platform for NLP, eKYC, Optimization Solver, Image Search, Address Purification, Document Self-learning Platform, Intelligent Visual Production, OpenPlatform for Digitized Virtual Human, Visual Intelligence API - Human Face & Human Body, Visual Intelligence API - Image Matting, Visual Intelligence API - Commodity Understanding, Visual Intelligence API - Image Production, Visual Intelligence API - Image Recognition, Visual Intelligence API - Text Recognition, Visual Intelligence API - Object Detection, Image Search, Alibaba Cloud Model Studio |
| Domains and websites | Enterprise Services |
| Big data search and analytics | Simple Log Service |
| Analytics computing | MaxCompute |
| Big data | Data Lake Analytics, Elasticsearch, Quick BI, Hologres, Data Lake Formation |
| Storage services | Photo and Drive Service |
| Security | Anti-DDoS, Anti-DDoS Resource Plan, Cloud Firewall, Bastionhost, Threat Intelligence, Anti-DDoS Pro, Captcha |
| Developer platform | Cloud Architect Design Tools |
| Technical support | Cloud Control API, Support Plan, Tag Service, CloudSSO, Alibaba Cloud Tickets |
| Network | Virtual Private Cloud, Cloud Enterprise Network, Anycast Elastic IP Address, Global Accelerator, Application Load Balancer, PrivateLink, Network Load Balancer, Network Intelligence Service |
| Video services | Apsara Video PaaS, ApsaraVideo Media Processing, Visual Edge Computing Service, Visual Compute Service, ApsaraVideo VOD |
Related topics
Interface overview -- Workflow Studio graphical interface reference.
Standard mode and express mode -- Differences between the two workflow modes.