Access CloudFlow by using Alibaba Cloud CLI - CloudFlow - Alibaba Cloud Documentation Center

This topic describes how to use Alibaba Cloud CLI to access CloudFlow.

Prerequisites

Alibaba Cloud CLI is installed in your system. For more information, see Install Alibaba Cloud CLI.
Alibaba Cloud CLI is configured. For more information, see Overview.

Note

We recommend that you use the latest version of Alibaba Cloud CLI. If you have used an earlier version of Alibaba Cloud CLI before you use CloudFlow, you may receive a message indicating that CloudFlow cannot be found." You can update Alibaba Cloud CLI to the latest version to resolve the issue.

Examples

This example shows how to run commands to access CloudFlow on Alibaba Cloud CLI.

After you install Alibaba Cloud CLI and configure the AccessKey ID and AccessKey secret, you can perform the following operations:

Query help information about CloudFlow

CLI example:

aliyun help fnf
Alibaba Cloud CLI x.x.x

Usage:
  aliyun fnf <ApiName> --parameter1 value1 --parameter2 value2 ...

Product: fnf (CloudFlow)
Version: 2019-03-15
Link: https://example.com/api/fnf

Available Api List:
  CreateFlow
  DeleteFlow
  DescribeExecution
  DescribeFlow
  DescribeRegions
  GetExecutionHistory
  ListExecutions
  ListFlows
  StartExecution
  StopExecution
  UpdateFlow

Run `aliyun fnf <ApiName> --help` to get more information about this API

Query help information about an API operation

CLI example:

aliyun fnf ListFlows --help
Alibaba Cloud CLI x.x.x

Product: fnf (CloudFlow)
Link: https://xxxxxx.html

Parameters:
  --Limit     String  Optional
  --NextToken String  Optional
  --RequestID String  Optional

The command output shows the information about an API operation, including Parameter, Type, Required.

Run subcommands

CLI example:

aliyun fnf ListFlows
{
    "Flows": [
        {
            "Name": "xxx",
            ...
        }
    ],
    "RequestId": "xxx"
}