Sie können einen Workflowschritt definieren, der einen HTTP-Aufruf durchführt, und die Antwort des Aufrufs einer Variablen zuweisen. Beispielsweise können Sie über eine HTTP-Anfrage einen Google Cloud-Dienst wie Cloud Functions oder Cloud Run aufrufen.
HTTP-Endpunkt aufrufen
Mit diesem Schritt können Sie eine HTTP-Anfrage stellen. Sowohl HTTP- als auch HTTPS-Anfragen werden unterstützt. Die gängigsten Methoden für HTTP-Anfragen haben eine Aufrufverknüpfung wie http.get und http.post. Sie können aber eine beliebige Methode verwenden, um Typ der HTTP-Anfrage. Dazu setzen Sie das Feld call
auf http.request
und geben den Anfragetyp im Feld method
an.
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" } } ]
Dabei gilt:
HTTP_REQUEST
: erforderlich. Verwenden Sie eines der folgenden Formate für HTTP-Anfragen: <ph type="x-smartling-placeholder">- </ph>
http.delete
http.get
http.patch
http.post
http.put
http.request
URL_VALUE
: erforderlich. URL, an die die Anfrage gesendet wird.REQUEST_METHOD
: erforderlich bei Verwendung des Anruftypshttp.request
. Der zu verwendende HTTP-Anfragetyp. Beispiel:GET
POST
PATCH
DELETE
REGISTERED_SERVICE
: Optional. Registrierte Person Service Directory-Dienstname im Formatprojects/PROJECT_ID/locations/LOCATION/namespaces/NAMESPACE_NAME/services/SERVICE_NAME
Weitere Informationen finden Sie unter Eine VPC Service Controls-konformer privater Endpunkt.HEADER_KEY
:HEADER_VALUE
: optional. Header-Felder für die Bereitstellung der APIWenn Sie den Medientyp des Anfragetexts mit einem
Content-Type
-Header angeben, werden nur die folgenden Typen unterstützt:application/json
oderapplication/type+json
– muss eine Karte seinapplication/x-www-form-urlencoded
: darf keine Codierung sein. Stringtext/type
— muss ein String sein.
Wenn ein
Content-Type
-Header angegeben ist, lautet der Textkörper wie vorgeschrieben codiert. Er kann beispielsweise JSON- oder URL-codiert sein.Wenn Sie einen
User-Agent
-Header verwenden, um den anfragenden User-Agent zu identifizieren, gilt Folgendes:- Die Standardeinstellung ist
GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs)
- Wenn ein Wert angegeben ist,
GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs)
an diesen Wert angehängt wirdWenn beispielsweise
User-Agent: "MY_USER_AGENT_VALUE"
angegeben ist, sieht der HTTP-Anfrageheader wie folgt aus (mit einem Leerzeichen zwischen dem angegebenen Wert und dem angehängten Standardwert):MY_USER_AGENT_VALUE GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs)
BODY_KEY
:BODY_VALUE
: optional. Textfelder zur Bereitstellung einer Eingabe für die APIWenn kein
Content-Type
-Header angegeben ist und eine Anfrage Text vorhanden ist, gilt Folgendes:- Wenn der Textwert in Byte liegt, wird der Header auf
Content-Type: application/octet-stream
- Andernfalls ist der Text JSON-codiert und der Header ist auf
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" }, ] } ] }
- Wenn der Textwert in Byte liegt, wird der Header auf
QUERY_KEY
:QUERY_VALUE
: optional. Abfragefelder zur Bereitstellung einer Eingabe für die APIAUTH_TYPE
: Optional. Erforderlich, wenn die aufgerufene API eine Authentifizierung erfordert. Verwenden Sie entwederOIDC
oderOAuth2
. Weitere Informationen finden Sie unter Authentifizierung durchführen Anfragen aus einem Workflow.AUTH_SCOPE
: Optional. Beschränkt die Zugriff auf das Konto eines Nutzers. Verwenden Sie entweder die Tastescope
oderscopes
.Der Schlüssel
scope
unterstützt entweder einen String oder eine Liste von Zeichenfolgen. Beispiel:"https://www.googleapis.com/auth/cloud-platform"
oder
["https://www.googleapis.com/auth/cloud-platform", "scope2", "scope3"]
Der
scopes
-Schlüssel, zusätzlich zur Unterstützung eines String oder Liste von Strings; unterstützt Leerzeichen und durch Kommas getrennte Strings. Beispiel:"https://www.googleapis.com/auth/cloud-platform scope2 scope3"
oder
"https://www.googleapis.com/auth/cloud-platform,scope2,scope3"
Weitere Informationen finden Sie unter <ph type="x-smartling-placeholder"></ph> OAuth 2.0-Bereiche für Google APIs.
AUDIENCE
: Optional. Gibt die Zielgruppe für das OIDC-Token. Standardmäßig ist es auf denselben Wert festgelegt wieurl
. Allerdings sollte sie auf die Stamm-URL Ihres Dienstes festgelegt sein. Hier einige Beispiele:https://region-project.cloudfunctions.net/hello_world
TIMEOUT_IN_SECONDS
: Optional. Dauer in Sekunden darf eine Anfrage ausgeführt werden, bevor eine Ausnahme ausgelöst wird. Die maximale Anzahl ist 1.800 Sekunden.RESULT_VALUE
: Optional. Variablenname, in dem das Ergebnis eines HTTP-Aufrufschritts gespeichert ist.
Auf in einer Variable gespeicherte HTTP-Antwortdaten zugreifen
Wenn der Content-Type
-Header für die Antwort ein
application/json
, also die JSON-Antwort, die in einem
wird automatisch in eine Karte konvertiert, auf die zugegriffen werden kann.
Ändern Sie bei Bedarf die aufgerufene API, um ein
application/json
-Medientyp für Content-Type
-Antwortheader. Andernfalls können Sie den
json.decode
und text.encode
, um
Antworttext in eine Map konvertieren. Beispiel:
json.decode(text.encode(RESPONSE_FROM_API))
Workflows enthalten einen integrierten Parser für den Zugriff auf diese Daten. Verwenden Sie die folgende Syntax, um über die HTTP-Antwort auf die Felder zuzugreifen:
${VARIABLE_NAME.body|code|headers.PATH_TO_FIELD}
Ersetzen Sie Folgendes:
VARIABLE_NAME
: der Name der Workflowvariablen, wobei haben Sie eine JSON-Antwort gespeichert.body
: Verwenden Sie das Feldbody
, um auf den Text der HTTP-Antwort zuzugreifen.code
: Verwenden Sie das Feldcode
, um auf den HTTP-Antwortcode zuzugreifen.headers
: Verwenden Sie das Feldheaders
, um namentlich auf die HTTP-Antwortheader zuzugreifen.PATH_TO_FIELD
: der Pfad zum Feld in der JSON-Datei auf die Sie zugreifen möchten. Das kann einfach der Name des Felds sein oder der Wert in einem Objekt verschachtelt ist, kann es die Formobject1.object2.field
haben.
Wenn eine API beispielsweise {"age":50}
zurückgibt und ein Workflow diese Antwort in einer Variablen mit dem Namen age_response
speichert, gibt das folgende Beispiel den Wert des Felds age
zurück: In diesem Fall gilt 50
:
age_response.body.age
Beispiele
Diese Beispiele veranschaulichen die Syntax.
Antwort von einem API-Aufruf zuweisen
Wenn Sie keinen eigenen Suchbegriff eingeben, wird in diesem Beispiel Ihr Google Cloud- Standort zum Erstellen eines Suchbegriffs, der an den Wikipedia API A wird eine Liste verwandter Wikipedia-Artikel zurückgegeben.
YAML
JSON
Externe HTTP-POST-Anfrage stellen
In diesem Beispiel wird eine POST-Anfrage an einen externen HTTP-Endpunkt gesendet.
YAML
JSON
Externe HTTP GET-Anfrage mit Headern senden
In diesem Beispiel wird eine HTTP GET-Anfrage mit einem benutzerdefinierten Header gesendet. Sie können auch benutzerdefinierte Headerdefinitionen festlegen, wenn Sie andere Arten von HTTP-Anfragen stellen.
YAML
JSON
OIDC zur Authentifizierung bei einer Anfrage an Cloud Functions verwenden
In diesem Beispiel wird eine HTTP-Anfrage mit OIDC durch Hinzufügen einerauth
zumargs
Abschnitt der Workflow-Definition, nachdem Sie die URL angegeben haben.
YAML
JSON
HTTP-Anfragefehler abfangen und verarbeiten
In diesem Beispiel wird ein benutzerdefinierter Ausnahme-Handler implementiert, der auf dem HTTP-Statuscode basiert. GET-Anfrage zurückgegeben. Der Workflow erkennt eine mögliche Ausnahme und gibt eine vordefinierte Fehlermeldung zurück. Wird eine Ausnahme nicht erkannt, Die Workflowausführung schlägt fehl und löst die Ausnahme aus, wie sie von der GET-Anfrage zurückgegeben wird. Informationen zu anderen Fehler-Tags finden Sie unter Workflowfehler:
YAML
JSON
Nächste Schritte
- Workflows mit Cloud Run und Cloud Functions verwenden
- VPC Service Controls-konformen privaten Endpunkt aufrufen
- Privaten lokalen Endpunkt, Compute Engine, GKE oder einen anderen Endpunkt durch Aktivieren von IAP aufrufen
- Referenz zur Workflows-Syntax