AI 助理
备案控制台
文档
输入文档关键字查找
首页 云工作流 云工作流 CloudFlow（新版） 开发参考 SDK参考 安装Node.js SDK

安装Node.js SDK

更新时间：
产品详情
相关技术圈
我的收藏

本文将详细介绍云工作流的Node.js SDK安装步骤及调用示例。以Node.js语言为例，本文将讲解如何调用云工作流以创建流程接口、获取流程相关信息接口，以及异步启动流程执行的接口为例，并提供完整的集成步骤。

前提条件

调用阿里云OpenAPI通常需要设置访问密钥（AccessKey）。请确保已创建AccessKey。具体操作，请参见创建AccessKey。为了避免凭据泄露，常见的方案是将其写入到环境变量中，更多安全方案请参见使用访问凭据访问阿里云OpenAPI最佳实践。

环境要求

Node.js >= 8.x。

步骤一：引入SDK

阿里云SDK支持泛化与特化两种方式调用OpenAPI，详情参见泛化调用与特化调用，不同的调用方式需要引入的SDK也不同。

获取特化调用SDK安装方式

V2.0 SDK中包含了参数处理、请求组装以及返回值处理等OpenAPI请求的主要逻辑。开发者只需安装相关产品的SDK包依赖，即可调用阿里云OpenAPI。

  1. 登录SDK中心，选择将要使用产品，例如您将要调用云工作流的API。

  2. 在安装页面，SDK 代系选择V2.0，所有语言选择TypeScript。然后在快速入门页签中，您可以获取云工作流的SDK安装方式。

fnf.png

获取泛化调用SDK安装方式

泛化调用方式不依赖任何一个产品的SDK，只依赖核心包@alicloud/openapi-client，即可调用阿里云API。Node.js语言安装配置文件如下，最新版本请参见alicloud/openapi-client：

npm i @alicloud/openapi-client

步骤二：初始化Client

请根据云工作流（FNF）所属地域正确填写服务接入地址（又称“访问端点”或“Endpoint”），关于服务接入地址的更多信息，请参见支持的地域。

以下将以特化调用代码为例，详细说明调用过程。如您选择泛化调用方案，更多信息请参见泛化调用与特化调用。

使用AK初始化

说明

阿里云账号AccessKey拥有所有OpenAPI的访问权限，建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。

本示例以将AccessKey配置在环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET的方式来实现身份验证为例。

'use strict';

const fnf20190315 = require('@alicloud/fnf20190315');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Tea = require('@alicloud/tea-typescript');

class Client {
  /**
   * 使用AK&SK初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient() {
  
    let config = new OpenApi.Config({
      // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    
    config.endpoint = `cn-hangzhou.fnf.aliyuncs.com`;
    
    return new fnf20190315.default(config);
  }
  
  static async main(args) {
    let client = Client.createClient();
  }
}

exports.Client = Client;
Client.main(process.argv.slice(2));

步骤三：使用已初始化的Client调用云工作流（FNF） API

说明

初始化Client后，您可以通过Client调用云工作流API。

接口名称：CreateFlow

此接口用于创建一个流程。在调用过程中，您需要根据实际业务需求创建请求对象，并设置相应的参数及运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

  // 创建请求对象
  let createFlowRequest = new fnf20190315.CreateFlowRequest({
      // 您的流程名字
      name: 'your_flow_name',
      // 流程定义，遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。
      definition: '旧版：
"
type: flow
version: v1
name: my_flow_name
steps:
  - type: pass
    name: mypass
"

新版：
"
Type: StateMachine
SpecVersion: v1
Name: my_flow_name
StartAt: my_state
States:
  - Type: Pass
    Name: my_state
    End: true
"',
      // 流程描述
      description: 'your test flow',
      // 流程类型
      type: 'FDL',
    });
    // 运行时配置
    let runtime = new Util.RuntimeOptions({ });

以下是使用AK创建一个流程的完整示例代码：

'use strict';

const fnf20190315 = require('@alicloud/fnf20190315');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * 使用AK&SK初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient() {

    let config = new OpenApi.Config({
      // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    
    config.endpoint = `cn-hangzhou.fnf.aliyuncs.com`;
    return new fnf20190315.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
     // 创建请求对象
  let createFlowRequest = new fnf20190315.CreateFlowRequest({
      // 您的流程名字
      name: 'your_flow_name',
      // 流程定义，遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容，当系统支持两种规范的流程定义规范。
      definition: '旧版：
"
type: flow
version: v1
name: my_flow_name
steps:
  - type: pass
    name: mypass
"

新版：
"
Type: StateMachine
SpecVersion: v1
Name: my_flow_name
StartAt: my_state
States:
  - Type: Pass
    Name: my_state
    End: true
"',
      // 流程描述
      description: 'your test flow',
      // 流程类型
      type: 'FDL',
    });
    // 运行时配置
    let runtime = new Util.RuntimeOptions({ });
    try {
      // 复制代码运行请自行打印 API 的返回值
      await client.createFlowWithOptions(createFlowRequest, runtime);
    } catch (error) {
      // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
      // 错误 message
      console.log(error.message);
      // 诊断地址
      console.log(error.data["Recommend"]);
      Util.default.assertAsString(error.message);
    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

接口名称：DescribeFlow

此接口用于获取特定流程的相关信息。在调用过程中，您需要根据实际业务需求创建请求对象，并设置相应的参数及运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

// 创建请求对象并设置入参
let describeFlowRequest = new fnf20190315.DescribeFlowRequest({
      // 您的流程名称
      name: 'your_flow_name',
    });
    // 创建运行时配置对象
    let runtime = new Util.RuntimeOptions({ });

以下是使用AK获取流程相关信息的完整示例代码：

'use strict';

const fnf20190315 = require('@alicloud/fnf20190315');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * 使用AK&SK初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient() {
   
    let config = new OpenApi.Config({
      // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
   
    config.endpoint = `cn-hangzhou.fnf.aliyuncs.com`;
    return new fnf20190315.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    // 创建请求对象
    let describeFlowRequest = new fnf20190315.DescribeFlowRequest({
      // 您的流程名称
      name: 'your_flow_name',
    });
    // 运行时配置
    let runtime = new Util.RuntimeOptions({ });
    try {
      // 复制代码运行请自行打印 API 的返回值
      await client.describeFlowWithOptions(describeFlowRequest, runtime);
    } catch (error) {
      // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
      // 错误 message
      console.log(error.message);
      // 诊断地址
      console.log(error.data["Recommend"]);
      Util.default.assertAsString(error.message);
    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

接口名称：StartExecution

此接口用于异步调用以启动一个流程的执行。在调用过程中，您需要根据实际业务需求构建请求对象，并设置相应的参数及运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

// 创建请求对象
let startExecutionRequest = new fnf20190315.StartExecutionRequest({
      // 您的开始执行流程名称
      flowName: 'your_flow_name',
      // 执行名称
      executionName: 'your_exec_name',
      // 执行的输入
      input: '{"key":"value"}',
      // 流程执行结束后回调TaskToken相关任务 示例值：12
      callbackFnFTaskToken: '12',
    });
// 运行时配置    
let runtime = new Util.RuntimeOptions({ });

以下是使用AK异步调用启动一个流程的执行的完整示例代码：

'use strict';

const fnf20190315 = require('@alicloud/fnf20190315');
const OpenApi = require('@alicloud/openapi-client');
const Util = require('@alicloud/tea-util');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * 使用AK&SK初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient() {

    let config = new OpenApi.Config({
      // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
      accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
      // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
      accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
    });
    config.endpoint = `cn-hangzhou.fnf.aliyuncs.com`;
    return new fnf20190315.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    // 创建请求对象
    let startExecutionRequest = new fnf20190315.StartExecutionRequest({
      // 您的开始执行流程名称
      flowName: 'your_flow_name',
      // 执行名称
      executionName: 'your_exec_name',
      // 执行的输入
      input: '{"key":"value"}',
      // 流程执行结束后回调TaskToken相关任务 示例值：12
      callbackFnFTaskToken: '12',
    });
    // 运行时配置
    let runtime = new Util.RuntimeOptions({ });
    try {
      // 复制代码运行请自行打印 API 的返回值
      await client.startExecutionWithOptions(startExecutionRequest, runtime);
    } catch (error) {
      // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
      // 错误 message
      console.log(error.message);
      // 诊断地址
      console.log(error.data["Recommend"]);
      Util.default.assertAsString(error.message);
    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

SDK调用示例

您可以使用API级别的多语言SDK Demo进行调试。示例代码，请参见开发者门户OpenAPI Explorer。

上一篇：安装Java SDK下一篇：安装PHP SDK
文档推荐