Envoyer une requête HTTP

Vous pouvez définir une étape de workflow qui effectue un appel HTTP et attribue la réponse de l'appel à une variable. Par exemple, vous pouvez appeler un service Google Cloud tel que Cloud Functions ou Cloud Run via une requête HTTP.

Appeler un point de terminaison HTTP

Ce type d'étape vous permet d'effectuer une requête HTTP. Les requêtes HTTP et HTTPS sont toutes deux acceptées. Les méthodes de requête HTTP les plus courantes possèdent un raccourci d'appel (tel que http.get et http.post), mais vous pouvez effectuer n'importe quel type de requête HTTP en définissant le champ call sur http.request et en spécifiant le type de requête à l'aide du champ method.

YAML

  - STEP_NAME:
      call: {HTTP_REQUEST}
      args:
          url: URL_VALUE
          method: REQUEST_METHOD
          headers:
              HEADER_KEY:HEADER_VALUE
              ...
          body:
              BODY_KEY:BODY_VALUE
              ...
          query:
              QUERY_KEY:QUERY_VALUE
              ...
          auth:
              type:{AUTH_TYPE}
          timeout: TIMEOUT_IN_SECONDS
      result: RESULT_VALUE
    

JSON

  [
    {
      "STEP_NAME": {
        "call": "{HTTP_REQUEST}",
        "args": {
          "url": "URL_VALUE",
          "method": "REQUEST_METHOD",
          "headers": {"HEADER_KEY":"HEADER_VALUE",
          ...
          },
          "body": {"BODY_KEY":"BODY_VALUE",
          ...
          },
          "query": {"QUERY_KEY":"QUERY_VALUE",
          ...
          },
          "auth": {"type":"{AUTH_TYPE}"},
          "timeout": "TIMEOUT_IN_SECONDS"
        },
        "result": "RESULT_VALUE"
      }
    }
  ]
    

Remplacez les éléments suivants :

  • HTTP_REQUEST : Obligatoire. Utilisez l'une des options suivantes pour les requêtes HTTP :
    • http.delete
    • http.get
    • http.patch
    • http.post
    • http.put
    • http.request
  • URL_VALUE : Obligatoire. URL vers laquelle la requête est envoyée.
  • REQUEST_METHOD: obligatoire si vous utilisez le type d'appel http.request. Type de la méthode de requête HTTP à utiliser. Exemple :
    • GET
    • POST
    • PATCH
    • DELETE
  • HEADER_KEY:HEADER_VALUE: Facultatif. Champs d'en-tête pour fournir l'entrée à l'API.

    Si vous utilisez un en-tête Content-Type pour spécifier le type de contenu du corps de la requête, seuls les types suivants sont acceptés:

    • application/json ou application/type+json : doit être une carte
    • application/x-www-form-urlencoded : doit être une chaîne non codée
    • text/type-doit être une chaîne.

    Si vous utilisez un en-tête User-Agent pour identifier le user-agent à l'origine de la requête, les critères suivants s'appliquent:

    • La valeur par défaut est GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs).
    • Si une valeur est spécifiée, GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs) est ajouté à cette valeur.

      Par exemple, si User-Agent: "MY_USER_AGENT_VALUE" est spécifié, l'en-tête de la requête HTTP se présente comme suit (avec un espace entre la valeur spécifiée et la valeur par défaut ajoutée):

      MY_USER_AGENT_VALUE GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs)
  • BODY_KEY:BODY_VALUE: Facultatif. Champs de corps permettant de fournir des entrées à l'API. La structure peut être équivalente à une charge utile JSON. Exemple :

    YAML

          body:
            requests:
            - image:
                source:
                  gcsImageUri: ${gsUri}
              features:
              - type: LABEL_DETECTION
              - type: SAFE_SEARCH_DETECTION
              - type: IMAGE_PROPERTIES
        result: imageAnalysisResponse
        

    JSON

    {
      "requests":[
        {
          "image": {
            "source": {
                "gcsUri": "img.png"
            }
          },
          "features": [
            { "type":"LABEL_DETECTION" },
            { "type":"SAFE_SEARCH_DETECTION" },
            { "type":"IMAGE_PROPERTIES" },
          ]
        }
      ]
    }
          
  • QUERY_KEY:QUERY_VALUE: Facultatif. Champs de requête permettant de fournir des entrées à l'API.
  • AUTH_TYPE : Facultatif. Obligatoire si l'API appelée nécessite une authentification. Utilisez OIDC ou OAuth2. Pour plus d'informations, consultez la page Effectuer des requêtes authentifiées.
  • TIMEOUT_IN_SECONDS : Facultatif. Durée d'exécution d'une requête, en secondes, avant de générer une exception. La valeur maximale est de 1 800 secondes.
  • RESULT_VALUE : Facultatif. Nom de la variable dans laquelle le résultat d'une étape d'appel HTTP est stocké.

Accéder aux données de réponse HTTP enregistrées dans une variable

Lorsqu'une réponse de type application/json est stockée dans une variable, la réponse JSON est convertie en une carte à laquelle vous accédez en tant que corps de réponse. Workflows inclut un analyseur intégré permettant d'accéder à ces données. Pour accéder aux champs à partir de la réponse HTTP, utilisez la syntaxe suivante:

${VARIABLE_NAME.body|code.PATH_TO_FIELD}

Remplacez les éléments suivants :

  • VARIABLE_NAME: nom de la variable de workflow dans laquelle vous avez enregistré une réponse JSON
  • body: utilisez le champ body pour accéder au corps de la réponse HTTP.
  • code: utilisez le champ code pour accéder au code de réponse HTTP.
  • PATH_TO_FIELD: chemin d'accès au champ de la réponse JSON auquel vous souhaitez accéder. Il peut s'agir du nom du champ ou, s'il est imbriqué dans un objet, peut prendre la forme object1.object2.field.

Par exemple, si une API renvoie {"age":50} et qu'un workflow stocke cette réponse dans une variable appelée age_response, l'exemple suivant renvoie la valeur du champ age ; Dans le cas présent, 50:

age_response.body.age

Exemples

Ces exemples illustrent la syntaxe.

Attribuer la réponse à partir d'un appel d'API

Cet exemple appelle un exemple d'API. Le jour de la semaine renvoyé est transmis à l'API Wikipédia. Les articles pertinents sur Wikipédia concernant le jour en cours de la semaine sont renvoyés.

YAML

- getCurrentTime:
    call: http.get
    args:
      url: https://us-central1-workflowsample.cloudfunctions.net/datetime
    result: currentTime
- readWikipedia:
    call: http.get
    args:
      url: https://en.wikipedia.org/w/api.php
      query:
        action: opensearch
        search: ${currentTime.body.dayOfTheWeek}
    result: wikiResult
- returnResult:
    return: ${wikiResult.body[1]}

JSON

[
  {
    "getCurrentTime": {
      "call": "http.get",
      "args": {
        "url": "https://us-central1-workflowsample.cloudfunctions.net/datetime"
      },
      "result": "currentTime"
    }
  },
  {
    "readWikipedia": {
      "call": "http.get",
      "args": {
        "url": "https://en.wikipedia.org/w/api.php",
        "query": {
          "action": "opensearch",
          "search": "${currentTime.body.dayOfTheWeek}"
        }
      },
      "result": "wikiResult"
    }
  },
  {
    "returnResult": {
      "return": "${wikiResult.body[1]}"
    }
  }
]

Envoyer une requête HTTP POST externe

Cet exemple envoie une requête POST à un point de terminaison HTTP externe.

YAML

- get_message:
    call: http.post
    args:
      url: https://www.example.com/endpoint
      body:
        some_val: "Hello World"
        another_val: 123
    result: the_message
- return_value:
    return: ${the_message.body}

JSON

[
  {
    "get_message": {
      "call": "http.post",
      "args": {
        "url": "https://www.example.com/endpoint",
        "body": {
          "some_val": "Hello World",
          "another_val": 123
        }
      },
      "result": "the_message"
    }
  },
  {
    "return_value": {
      "return": "${the_message.body}"
    }
  }
]

Créer une requête HTTP GET externe avec des en-têtes

Cet exemple effectue une requête HTTP GET avec un en-tête personnalisé. Vous pouvez également fournir des définitions d'en-têtes personnalisés lorsque vous effectuez d'autres types de requêtes HTTP.

YAML

- get_message:
    call: http.get
    args:
      url: https://www.example.com/endpoint
      headers:
        Content-Type: "text/plain"
      query:
        some_val: "Hello World"
        another_val: 123
    result: the_message
- return_value:
    return: ${the_message.body}

JSON

[
  {
    "get_message": {
      "call": "http.get",
      "args": {
        "url": "https://www.example.com/endpoint",
        "headers": {
          "Content-Type": "text/plain"
        },
        "query": {
          "some_val": "Hello World",
          "another_val": 123
        }
      },
      "result": "the_message"
    }
  },
  {
    "return_value": {
      "return": "${the_message.body}"
    }
  }
]

Utiliser OIDC pour l'authentification lors de l'envoi de requêtes à Cloud Functions

Cet exemple effectue une requête HTTP à l'aide d'OIDC en ajoutant une section auth à la section args de la définition du workflow, après avoir spécifié l'URL.

YAML

- call_my_function:
    call: http.post
    args:
      url: https://us-central1-myproject123.cloudfunctions.net/myfunc1
      auth:
        type: OIDC
      body:
        some_val: "Hello World"
        another_val: 123
    result: the_message
- return_value:
    return: ${the_message.body}

JSON

[
  {
    "call_my_function": {
      "call": "http.post",
      "args": {
        "url": "https://us-central1-myproject123.cloudfunctions.net/myfunc1",
        "auth": {
          "type": "OIDC"
        },
        "body": {
          "some_val": "Hello World",
          "another_val": 123
        }
      },
      "result": "the_message"
    }
  },
  {
    "return_value": {
      "return": "${the_message.body}"
    }
  }
]

Étape suivante