使用 API Gateway 集成调用在 Fargate 上运行的微服务 - Amazon Step Functions
第 1 步：创建状态机并预置资源第 2 步：运行状态机示例状态机代码IAM 示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用 API Gateway 集成调用在 Fargate 上运行的微服务

此示例项目演示了如何使用 Step Functions 调用 API Gateway Amazon Fargate，以便与开启的服务进行交互，并检查调用是否成功。

有关 API Gateway 和 Step Functions 服务集成的更多信息，请参阅以下内容：

注意

此示例项目可能会产生费用。

对于新 Amazon 用户，可以使用免费使用套餐。在此套餐中，低于某种使用水平的服务是免费的。有关 Amazon 费用和免费套餐的更多信息，请参阅定价。

第 1 步：创建状态机并预置资源

  1. 打开 Step Functions 控制台，然后选择创建状态机。

  2. 在搜索框中键入 Call a microservice with API Gateway，然后从返回的搜索结果中选择使用 API Gateway 调用微服务。

  3. 选择下一步以继续。

  4. Step Functions 列出了您选择的示例项目中 Amazon Web Services 使用的。它还显示了示例项目的工作流图。将此项目部署到您的， Amazon Web Services 账户 或者将其用作构建您自己的项目的起点。根据您想继续的方式，选择运行演示或构建依据。

    该示例项目部署了以下资源：

    • 一个 Amazon API Gateway HTTP API，被状态机调用。

    • 一个 Amazon API Gateway Amazon VPC 链接。

    • Amazon Virtual Private Cloud。

    • Application Load Balancer。

    • 一个 Fargate 集群。

    • 一个 Amazon SNS 主题

    • 一台 Amazon Step Functions 状态机

    • 相关 Amazon Identity and Access Management (IAM) 角色

    • 要使这些资源协同工作，还需要多项其他服务。

    下图显示了使用 API Gateway 调用微服务示例项目的工作流图：

    使用 API Gateway 调用微服务示例项目的工作流程图。

  5. 选择使用模板继续进行选择。

  6. 请执行以下操作之一：

    • 如果您选择构建依据，Step Functions 将为您选择的示例项目创建工作流原型。Step Functions 不会部署工作流定义中列出的资源。

      在 Workflow Studio 的设计模式下，从状态浏览器中拖放状态，继续构建工作流原型。或者切换到代码模式，该模式提供了一个类似于 VS Code 的集成代码编辑器，用于在 Step Functions 控制台中更新状态机的 Amazon States Language（ASL）定义。有关使用 Workflow Studio 构建状态机的更多信息，请参阅使用 Workflow Studio。

      重要

      请记住，在运行工作流之前，为示例项目中使用的资源更新占位符 Amazon 资源名称 (ARN)。

    • 如果您选择了 “运行演示”，Step Functions 将创建一个只读示例项目，该项目使用 Amazon CloudFormation 模板将该模板中列出的 Amazon 资源部署到您的 Amazon Web Services 账户。

      提示

      要查看示例项目的状态机定义，请选择代码。

      准备就绪后，选择部署并运行以部署示例项目并创建资源。

      创建这些资源和相关 IAM 权限可能需要长达 10 分钟的时间。在部署资源时，您可以打开 CloudFormation 堆栈 ID 链接以查看正在配置哪些资源。

      创建示例项目中的所有资源后，您可以在状态机页面上看到新的示例项目。

      重要

      CloudFormation 模板中使用的每项服务都可能收取标准费用。

第 2 步：运行状态机

  1. 在状态机页面上，选择您的示例项目。

  2. 在示例项目页面上，选择启动执行。

  3. 在启动执行对话框中，执行以下操作：

    1. （可选）要识别您的执行，您可以在名称框中为其指定一个名称。默认情况下，Step Functions 会自动生成一个唯一的执行名称。

      注意

      Step Functions 允许您为状态机、执行和活动创建名称，以及包含非 ASCII 字符的标签。这些非 ASCII 名称不适用于亚马逊。 CloudWatch为确保您可以跟踪 CloudWatch 指标，请选择仅使用 ASCII 字符的名称。

    2. （可选）在输入框中，以 JSON 格式输入输入值以便运行工作流。

      如果您选择运行演示，则无需提供任何执行输入。

      注意

      如果您部署的演示项目包含预先填充的执行输入数据，请使用该输入来运行状态机。

    3. 选择启动执行。

    4. Step Functions 控制台会将您引导到一个以您的执行 ID 为标题的页面。该页面被称为执行详细信息页面。在此页面上，您可以随着执行的进展或者在执行完成后查看执行结果。

      要查看执行结果，请在图表视图上选择各个状态，然后在步骤详细信息窗格中选择各个选项卡，分别查看每个状态的详细信息，包括输入、输出和定义。有关可在执行详细信息页面上查看的执行信息的详细信息，请参阅“执行详细信息”页面 – 界面概述。

示例状态机代码

此示例项目中的状态机通过调用连接到 Fargate 上服务的 API Gateway HTTP API 与 API Gateway 集成。它托管在私有子网上，并通过私有应用程序负载均衡器进行访问。

浏览此示例状态机，了解 Step Functions 如何与 API Gateway 交互并返回结果。

有关 Amazon Step Functions 如何控制其他 Amazon 服务的更多信息，请参阅与其他服务 Amazon Step Functions 一起使用。

{
  "Comment": "Calling APIGW HTTP Endpoint",
  "StartAt": "Call API",
  "States": {
    "Call API": {
      "Type": "Task",
      "Resource": "arn:<PARTITION>:states:::apigateway:invoke",
      "Parameters": {
        "ApiEndpoint": "<API_ENDPOINT>",
        "Method": "GET",
        "AuthType": "IAM_ROLE"
      },
      "Next": "Call Successful?"
    },
    "Call Successful?": {
      "Type": "Choice",
      "Choices": [
        {
          "Variable": "$.StatusCode",
          "NumericEquals": 200,
          "Next": "Notify Success"
        }
      ],
      "Default": "Notify Failure"
    },
    "Notify Success": {
      "Type": "Task",
      "Resource": "arn:<PARTITION>:states:::sns:publish",
      "Parameters": {
        "Message": "Call was successful",
        "TopicArn": "<SNS_TOPIC_ARN>"
      },
      "End": true
    },
    "Notify Failure": {
      "Type": "Task",
      "Resource": "arn:<PARTITION>:states:::sns:publish",
      "Parameters": {
        "Message": "Call was not successful",
        "TopicArn": "<SNS_TOPIC_ARN>"
      },
      "End": true
    }
  }
}

有关在将 Step Functions 与其他 Amazon 服务一起使用时如何配置 IAM 的信息，请参阅集成服务的 IAM 策略。

IAM 示例

示例项目生成的这些示例 Amazon Identity and Access Management (IAM) 策略包括执行状态机和相关资源所需的最低权限。我们建议在您的 IAM 策略中仅包含这些必需的权限。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "sns:Publish"
            ],
            "Resource": [
                "arn:aws:sns:us-east-1:111122223333:apigw-ecs-sample-2000-SNSTopic-444455556666"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "execute-api:Invoke"
            ],
            "Resource": [
                "arn:aws:execute-api:us-east-1:111122223333:444444444444/*/GET/*"
            ],
            "Effect": "Allow"
        }
    ]
}
{
    "Statement": [
        {
            "Action": [
                "ec2:AttachNetworkInterface",
                "ec2:CreateNetworkInterface",
                "ec2:CreateNetworkInterfacePermission",
                "ec2:DeleteNetworkInterface",
                "ec2:DeleteNetworkInterfacePermission",
                "ec2:Describe*",
                "ec2:DetachNetworkInterface",
                "elasticloadbalancing:DeregisterInstancesFromLoadBalancer",
                "elasticloadbalancing:DeregisterTargets",
                "elasticloadbalancing:Describe*",
                "elasticloadbalancing:RegisterInstancesWithLoadBalancer",
                "elasticloadbalancing:RegisterTargets"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}
{
    "Statement": [
        {
            "Action": [
                "ecr:GetAuthorizationToken",
                "ecr:BatchCheckLayerAvailability",
                "ecr:GetDownloadUrlForLayer",
                "ecr:BatchGetImage",
                "logs:CreateLogStream",
                "logs:PutLogEvents"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

有关在将 Step Functions 与其他 Amazon 服务一起使用时如何配置 IAM 的信息，请参阅集成服务的 IAM 策略。