This topic describes how to use Alibaba Cloud Command Line Interface (Alibaba Cloud CLI) to access Serverless Workflow.

Prerequisites

  1. You have installed Alibaba Cloud CLI. For more information, see Installation Guide.
  2. You have configured Alibaba Cloud CLI. For more information, see Configure Alibaba Cloud CLI.
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 Serverless Workflow, you may receive a message indicating that Serverless Workflow cannot be found. Update Alibaba Cloud CLI to the latest version.

Examples

This example is intended for Serverless Workflow. It allows you to run commands to access Serverless Workflow on Alibaba Cloud CLI.

After you install Alibaba Cloud CLI and configure the AccessKeyID and AccessKeySecret, you can perform the following operations:

  • Query help information about Serverless Workflow

    CLI example:

    [~]$ aliyun help fnf
    Alibaba Cloud CLI x.x.x
    
    Usage:
      aliyun fnf <ApiName> --parameter1 value1 --parameter2 value2 ...
    
    Product: fnf (Serverless Workflow)
    Version: 2019-03-15
    
    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 3.0.12
    
    Product: fnf (Serverless Workflow)
    
    Parameters:
      --Limit     String  Optional
      --NextToken String  Optional
      --RequestID String  Optional    

    This command outputs the information about an API operation, including Parameter, Type, Required.

  • Run subcommands

    CLI example:

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