📜  Fnf 源代码 APIStuff (1)

📅  最后修改于: 2023-12-03 14:41:17.627000             🧑  作者: Mango

Fnf 源代码 APIStuff

Fnf源代码APIStuff是一个用于Fnf API的开发工具包,它提供了一组简单易用的API,使开发者能够更易于使用Fnf API来构建强大的服务和应用程序。

安装

要安装Fnf源代码APIStuff,请使用以下命令:

npm install fnf-api-stuff --save
使用

启动一个任务:

const FnfApiStuff = require('fnf-api-stuff');

const fnfApiStuff = new FnfApiStuff({
  accessKeyId: 'your-accessKeyId',
  secretAccessKey: 'your-secretAccessKey',
  region: 'your-region',
});

const taskName = 'your-task-name';
const input = { your_input: 'your_input_value' };

fnfApiStuff.startExecution({
  stateMachineArn: `arn:aws:states:${region}:your-aws-account-id:stateMachine:${taskName}`,
  input: JSON.stringify(input),
})
  .then((res) => {
    console.log(res.executionArn);
  })
  .catch((err) => {
    console.error(err);
  });

停止一个任务:

const FnfApiStuff = require('fnf-api-stuff');

const fnfApiStuff = new FnfApiStuff({
  accessKeyId: 'your-accessKeyId',
  secretAccessKey: 'your-secretAccessKey',
  region: 'your-region',
});

const executionArn = 'your-execution-arn';

fnfApiStuff.stopExecution({
  executionArn,
})
  .then((res) => {
    console.log(res.stopDate);
  })
  .catch((err) => {
    console.error(err);
  });
API

Fnf源代码APIStuff暴露以下API:

.startExecution(params)

启动一个任务。

参数:

  • params {Object} - 启动执行所需的参数。
    • stateMachineArn {String} - 状态机 ARN。
    • input {String} - 任务输入。

返回值:

返回Promise,它将被解决为包含以下对象的响应:

  • executionArn {String} - 执行的ARN。
.stopExecution(params)

停止一个任务。

参数:

  • params {Object} - 停止执行所需的参数。
    • executionArn {String} - 执行的ARN。

返回值:

返回Promise,它将被解决为包含以下对象的响应:

  • stopDate {Date} - 停止日期。
结论

Fnf源代码APIStuff是一个强大和易用的工具包,它可以帮助开发人员更好地使用Fnf API来构建可靠的任务。将其与其他Aws服务相结合,许多潜在的用例都可以使用。它是一个开发Fnf API的必备工具,可以节省时间和精力。