Chiama un microservizio in esecuzione su Fargate utilizzando l'integrazione API Gateway

Questo progetto di esempio dimostra come utilizzare Step Functions per effettuare una chiamata ad API Gateway per interagire con un servizio attivo e anche per verificare se la chiamata è riuscita. AWS Fargate

Per ulteriori informazioni sulle integrazioni dei servizi API Gateway e Step Functions, consulta quanto segue:

• Utilizzo AWS Step Functions con altri servizi

• Chiama API Gateway con Step Functions

Nota

Questo progetto di esempio potrebbe comportare costi.

Per i nuovi AWS utenti, è disponibile un livello di utilizzo gratuito. In questo piano, i servizi sono gratuiti al di sotto di un determinato livello di utilizzo. Per ulteriori informazioni sui AWS costi e sul piano gratuito, consulta la sezione Prezzi.

Fase 1: Creazione della macchina a stati e fornitura delle risorse

1. Apri la console Step Functions e scegli Crea macchina a stati.

2. Digita Call a microservice with API Gateway nella casella di ricerca, quindi scegli Chiama un microservizio con API Gateway tra i risultati della ricerca restituiti.

3. Seleziona Successivo per continuare.

4. Step Functions elenca quelli Servizi AWS utilizzati nel progetto di esempio selezionato. Mostra anche un grafico del flusso di lavoro per il progetto di esempio. Implementa questo progetto sul tuo Account AWS o usalo come punto di partenza per creare i tuoi progetti. In base a come vuoi procedere, scegli Esegui una demo o Sviluppa su di essa.

   Questo progetto di esempio utilizza le seguenti risorse:

   • Un'API Amazon API Gateway HTTP che viene chiamata dalla macchina a stati.

   • Un Amazon API Gateway Amazon VPC link.

   • Un Amazon Virtual Private Cloud.

   • Un Application Load Balancer.

   • Un Fargate grappolo.

   • Un argomento Amazon SNS

   • Una macchina a AWS Step Functions stati

   • Ruoli correlati AWS Identity and Access Management (IAM)

   • Diversi servizi aggiuntivi necessari per consentire a queste risorse di funzionare insieme.

   L'immagine seguente mostra il grafico del flusso di lavoro per il progetto Call a microservice with API Gateway sample:

   

5. Scegli Usa modello per continuare con la selezione.

6. Esegui una di queste operazioni:

   • Se hai selezionato Build on it, Step Functions crea il prototipo del flusso di lavoro per il progetto di esempio selezionato. Step Functions non distribuisce le risorse elencate nella definizione del flusso di lavoro.

     In Workflow StudioModalità di progettazione, trascina gli stati da e continua Stati del browser a creare il tuo prototipo di flusso di lavoro. Oppure passa a Modalità codice quello che fornisce un editor di codice integrato simile a VS Code per aggiornare la definizione Amazon States Language (ASL) della tua macchina a stati all'interno della console Step Functions. Per ulteriori informazioni sull'utilizzo di Workflow Studio per creare macchine a stati, consultaUtilizzo di Workflow Studio.

     Importante

     Ricordati di aggiornare il segnaposto Amazon Resource Name (ARN) per le risorse utilizzate nel progetto di esempio prima di eseguire il flusso di lavoro.

   • Se hai selezionato Esegui una demo, Step Functions crea un progetto di esempio di sola lettura che utilizza un AWS CloudFormation modello per distribuire le AWS risorse elencate in quel modello sul tuo. Account AWS

     Suggerimento

     Per visualizzare la definizione della macchina a stati del progetto di esempio, scegli Code.

     Quando sei pronto, scegli Distribuisci ed esegui per distribuire il progetto di esempio e creare le risorse.

     La creazione di queste risorse e delle relative autorizzazioni IAM può richiedere fino a 10 minuti. Mentre le risorse vengono distribuite, puoi aprire il link CloudFormation Stack ID per vedere quali risorse vengono fornite.

     Dopo aver creato tutte le risorse del progetto di esempio, puoi vedere il nuovo progetto di esempio elencato nella pagina State machines.

     Importante

     Potrebbero essere applicate tariffe standard per ogni servizio utilizzato nel CloudFormation modello.

Fase 2: Eseguire la macchina a stati

1. Nella pagina Macchine a stati, scegli il tuo progetto di esempio.

2. Nella pagina del progetto di esempio, scegli Avvia esecuzione.

3. Nella finestra di dialogo Avvia esecuzione, effettuate le seguenti operazioni:

   1. (Facoltativo) Per identificare l'esecuzione, potete specificarne un nome nella casella Nome. Per impostazione predefinita, Step Functions genera automaticamente un nome di esecuzione univoco.

      Nota

      Step Functions consente di creare nomi per macchine a stati, esecuzioni e attività ed etichette che contengono caratteri non ASCII. Questi nomi non ASCII non funzionano con Amazon. CloudWatch Per assicurarti di poter tenere traccia delle CloudWatch metriche, scegli un nome che utilizzi solo caratteri ASCII.

   2. (Facoltativo) Nella casella Input, inserisci i valori di input in formato JSON per eseguire il flusso di lavoro.

      Se avete scelto di eseguire una demo, non è necessario fornire alcun input di esecuzione.

      Nota

      Se il progetto demo che hai distribuito contiene dati di input di esecuzione precompilati, usa quell'input per eseguire la macchina a stati.

   3. Selezionare Start execution (Avvia esecuzione).

   4. La console Step Functions ti indirizza a una pagina intitolata con il tuo ID di esecuzione. Questa pagina è nota come pagina dei dettagli di esecuzione. In questa pagina è possibile esaminare i risultati dell'esecuzione man mano che l'esecuzione procede o dopo il suo completamento.

      Per esaminare i risultati dell'esecuzione, scegliete i singoli stati nella vista Grafico, quindi scegliete le singole schede Dettagli del passaggio nel riquadro per visualizzare i dettagli di ogni stato, inclusi rispettivamente input, output e definizione. Per i dettagli sulle informazioni sull'esecuzione che è possibile visualizzare nella pagina Dettagli di esecuzione, vederePagina dei dettagli di esecuzione: panoramica dell'interfaccia.

Esempio di codice della macchina a stati

La macchina a stati di questo progetto di esempio si integra con API Gateway chiamando un'API HTTP API Gateway connessa a un servizio su Fargate. È ospitato su una sottorete privata e vi si accede tramite un sistema di bilanciamento del carico delle applicazioni privato.

Sfoglia questo esempio di macchina a stati per vedere come Step Functions interagisce con API Gateway e restituisce risultati.

Per ulteriori informazioni su come AWS Step Functions controllare altri AWS servizi, consultaUtilizzo AWS Step Functions con altri servizi.

{
  "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
    }
  }
}

Per informazioni su come configurare IAM quando si utilizza Step Functions con altri AWS servizi, vederePolitiche IAM per servizi integrati.

Esempio IAM

Questi esempi di policy AWS Identity and Access Management (IAM) generati dal progetto di esempio includono il privilegio minimo necessario per eseguire la macchina a stati e le risorse correlate. Ti consigliamo di includere solo le autorizzazioni necessarie nelle tue policy 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"
        }
    ]
}

Per informazioni su come configurare IAM quando si utilizza Step Functions con altri AWS servizi, vederePolitiche IAM per servizi integrati.