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 private_service_name: "REGISTERED_SERVICE" headers: HEADER_KEY:HEADER_VALUE ... body: BODY_KEY:BODY_VALUE ... query: QUERY_KEY:QUERY_VALUE ... auth: type: AUTH_TYPE scope: AUTH_SCOPE scopes: AUTH_SCOPE audience: AUDIENCE timeout: TIMEOUT_IN_SECONDS result: RESULT_VALUE
JSON
[ { "STEP_NAME": { "call": "HTTP_REQUEST", "args": { "url": "URL_VALUE", "method": "REQUEST_METHOD", "private_service_name": "REGISTERED_SERVICE", "headers": {"HEADER_KEY":"HEADER_VALUE", ... }, "body": {"BODY_KEY":"BODY_VALUE", ... }, "query": {"QUERY_KEY":"QUERY_VALUE", ... }, "auth": { "type":"AUTH_TYPE", "scope":"AUTH_SCOPE", "scopes":"AUTH_SCOPE", "audience":"AUDIENCE" }, "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'appelhttp.request
. Type de la méthode de requête HTTP à utiliser. Exemple :GET
POST
PATCH
DELETE
REGISTERED_SERVICE
: Facultatif. Nom de service de l'Annuaire des services enregistré au formatprojects/PROJECT_ID/locations/LOCATION/namespaces/NAMESPACE_NAME/services/SERVICE_NAME
. Pour plus d'informations, consultez la section Appeler un point de terminaison privé compatible avec VPC Service Controls.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
ouapplication/type+json
: doit être une carteapplication/x-www-form-urlencoded
: doit être une chaîne non encodéetext/type
-doit être une chaîne.
Si un en-tête
Content-Type
est spécifié, le corps est encodé comme prescrit. (au format JSON ou URL, par exemple).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 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.Si aucun en-tête
Content-Type
n'est spécifié et qu'un corps de requête est présent, les conditions suivantes s'appliquent:- Si la valeur du corps est exprimée en octets, l'en-tête est défini sur
Content-Type: application/octet-stream
. - Sinon, le corps est encodé au format JSON et l'en-tête est défini sur
Content-Type: application/json; charset=utf-8
.
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" }, ] } ] }
- Si la valeur du corps est exprimée en octets, l'en-tête est défini sur
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. UtilisezOIDC
ouOAuth2
. Pour en savoir plus, consultez la page Envoyer des requêtes authentifiées à partir d'un workflow.AUTH_SCOPE
: Facultatif. Limite l'accès d'une application au compte d'un utilisateur. Utilisez la cléscope
ouscopes
.La clé
scope
accepte une chaîne ou une liste de chaînes. Exemple :"https://www.googleapis.com/auth/cloud-platform"
ou
["https://www.googleapis.com/auth/cloud-platform", "scope2", "scope3"]
La clé
scopes
accepte non seulement une chaîne ou une liste de chaînes, mais elle accepte également les chaînes séparées par des espaces et des virgules. Exemple :"https://www.googleapis.com/auth/cloud-platform scope2 scope3"
ou
"https://www.googleapis.com/auth/cloud-platform,scope2,scope3"
Pour en savoir plus, consultez Champs d'application OAuth 2.0 pour les API Google.
AUDIENCE
: Facultatif. Spécifie l'audience du jeton OIDC. Par défaut, cette valeur est définie sur la même valeur queurl
. Cependant, elle doit être définie sur l'URL racine de votre service. Exemple :https://region-project.cloudfunctions.net/hello_world
.
TIMEOUT_IN_SECONDS
: Facultatif. Durée d'exécution, en secondes, d'une requête 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
Si l'en-tête Content-Type
de la réponse spécifie un type de média application/json
, la réponse JSON stockée dans une variable est automatiquement convertie en une carte accessible.
Si nécessaire, modifiez l'API appelée afin de spécifier un type de média application/json
pour l'en-tête de réponse Content-Type
. Sinon, vous pouvez utiliser les fonctions json.decode
et text.encode
pour convertir le corps de la réponse en carte. Exemple :
json.decode(text.encode(RESPONSE_FROM_API))
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|headers.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 champbody
pour accéder au corps de la réponse HTTP.code
: utilisez le champcode
pour accéder au code de réponse HTTP.headers
: utilisez le champheaders
pour accéder aux en-têtes de réponse HTTP par nom.PATH_TO_FIELD
: chemin d'accès au champ de la réponse JSON auquel vous souhaitez accéder. Il peut s'agir simplement du nom du champ, ou si le champ est imbriqué dans un objet, il peut prendre la formeobject1.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
À moins que vous ne saisissiez votre propre terme de recherche, cet exemple utilise votre emplacement Google Cloud pour construire un terme de recherche, qu'il transmet à l'API Wikipédia. La liste des articles Wikipédia associés s'affiche.
YAML
JSON
Envoyer une requête HTTP POST externe
Cet exemple envoie une requête POST à un point de terminaison HTTP externe.
YAML
JSON
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
JSON
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
JSON
Détecter et gérer les erreurs de requête HTTP
Cet exemple met en œuvre un gestionnaire d'exceptions personnalisé basé sur le code d'état HTTP renvoyé par la requête GET. Le workflow intercepte une exception potentielle et renvoie un message d'erreur prédéfini. Si une exception n'est pas reconnue, l'exécution du workflow échoue et génère l'exception renvoyée par la requête GET. Pour les autres tags d'erreur, consultez la section Erreurs de workflow.
YAML
JSON
Étapes suivantes
- Tutoriel Utiliser les workflows avec Cloud Run et Cloud Functions
- Appeler un point de terminaison privé compatible avec VPC Service Controls
- Appeler un point de terminaison privé sur site, Compute Engine, GKE ou un autre point de terminaison en activant IAP
- Documentation de référence sur la syntaxe des workflows