Puedes definir un paso del flujo de trabajo que realice una llamada HTTP y asignar la respuesta de la llamada a una variable. Por ejemplo, puedes invocar un servicio de Google Cloud como Cloud Functions o Cloud Run mediante una solicitud HTTP.
Invoca un extremo HTTP
Este tipo de paso te permite realizar una solicitud HTTP. Se admiten las solicitudes HTTP y HTTPS. Los métodos de solicitud HTTP más comunes tienen un acceso directo de llamada (como http.get y http.post), pero puedes realizar cualquier tipo de solicitud HTTP si configuras el campo call
en http.request
y especificas el tipo de solicitud con el campo 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" } } ]
Reemplaza lo siguiente:
HTTP_REQUEST
: obligatorio. Usa una de las siguientes opciones para las solicitudes HTTP:http.delete
http.get
http.patch
http.post
http.put
http.request
URL_VALUE
: obligatorio. URL a la que se envía la solicitud.REQUEST_METHOD
: Es obligatorio si se usa el tipo de llamadahttp.request
. El tipo de método de solicitud HTTP que se usará. Por ejemplo:GET
POST
PATCH
DELETE
REGISTERED_SERVICE
: es opcional. Un nombre de servicio registrado del Directorio de servicios en el formatoprojects/PROJECT_ID/locations/LOCATION/namespaces/NAMESPACE_NAME/services/SERVICE_NAME
. Para obtener más información, consulta Invoca un extremo privado que cumpla con los Controles del servicio de VPC.HEADER_KEY
:HEADER_VALUE
: Es opcional. Campos de encabezado para proporcionar entrada a la APISi usas un encabezado
Content-Type
para especificar el tipo de contenido multimedia del cuerpo de la solicitud, solo se admiten los siguientes tipos:application/json
oapplication/type+json
: deben ser un mapa.application/x-www-form-urlencoded
(debe ser una string sin codificación)text/type
: Debe ser una cadena.
Si se especifica un encabezado
Content-Type
, el cuerpo se codifica según lo prescrito. Por ejemplo, el formato puede ser JSON o estar codificado en una URL.Si se usa un encabezado
User-Agent
para identificar al usuario-agente solicitante, se aplica lo siguiente:- El valor predeterminado es
GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs)
. - Si se especifica un valor, se agrega
GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs)
a ese valorPor ejemplo, si se especifica
User-Agent: "MY_USER_AGENT_VALUE"
, el encabezado de la solicitud HTTP sería el siguiente (con un espacio entre el valor especificado y el valor predeterminado agregado):MY_USER_AGENT_VALUE GoogleCloudWorkflows; (+https://cloud.google.com/workflows/docs)
BODY_KEY
:BODY_VALUE
: Es opcional. Campos del cuerpo para proporcionar entrada a la APISi no se especifica un encabezado
Content-Type
y si hay un cuerpo de solicitud, se aplica lo siguiente:- Si el valor del cuerpo es de bytes, el encabezado se establece en
Content-Type: application/octet-stream
. - De lo contrario, el cuerpo está codificado en JSON y el encabezado se configura como
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 el valor del cuerpo es de bytes, el encabezado se establece en
QUERY_KEY
:QUERY_VALUE
: Es opcional. Campos de consulta para suministrar entrada a la APIAUTH_TYPE
: es opcional. Obligatorio si la API a la que se llama requiere autenticación. UsaOIDC
oOAuth2
. Para obtener más información, consulta Realiza solicitudes autenticadas desde un flujo de trabajo.AUTH_SCOPE
: es opcional. Limita el acceso de una aplicación a la cuenta de un usuario. Usa la teclascope
oscopes
.La clave
scope
admite una cadena o una lista de cadenas. Por ejemplo:"https://www.googleapis.com/auth/cloud-platform"
o
["https://www.googleapis.com/auth/cloud-platform", "scope2", "scope3"]
La clave
scopes
, además de admitir una string o lista de strings, admite strings separadas por espacios y comas. Por ejemplo:"https://www.googleapis.com/auth/cloud-platform scope2 scope3"
o
"https://www.googleapis.com/auth/cloud-platform,scope2,scope3"
Si deseas obtener más información, consulta los permisos de OAuth 2.0 para las APIs de Google.
AUDIENCE
: es opcional. Especifica el público para el token de OIDC. De forma predeterminada, se establece con el mismo valor queurl
. Sin embargo, se debe establecer en la URL raíz de tu servicio. Por ejemplo:https://region-project.cloudfunctions.net/hello_world
.
TIMEOUT_IN_SECONDS
: es opcional. El tiempo en segundos que puede ejecutarse una solicitud antes de que se genere una excepción. La cantidad máxima es de 1,800 segundos.RESULT_VALUE
: es opcional. Nombre de la variable donde se almacena el resultado de un paso de invocación HTTP.
Cómo acceder a los datos de respuestas HTTP guardados en una variable
Si el encabezado Content-Type
de la respuesta especifica un tipo de medio application/json
, la respuesta JSON que se almacena en una variable se convierte automáticamente en un mapa al que se puede acceder.
Si es necesario, modifica la API a la que se llama para especificar un tipo de medio application/json
para el encabezado de respuesta Content-Type
. De lo contrario, puedes usar las funciones json.decode
y text.encode
para convertir el cuerpo de la respuesta en un mapa. Por ejemplo:
json.decode(text.encode(RESPONSE_FROM_API))
Workflows incluye un analizador integrado para acceder a estos datos. Para acceder a los campos de la respuesta HTTP, usa la siguiente sintaxis:
${VARIABLE_NAME.body|code|headers.PATH_TO_FIELD}
Reemplaza lo siguiente:
VARIABLE_NAME
: Es el nombre de la variable de flujo de trabajo en la que guardaste una respuesta JSON.body
: Usa el campobody
para acceder al cuerpo de la respuesta HTTP.code
: Usa el campocode
para acceder al código de respuesta HTTP.headers
: Usa el campoheaders
para acceder a los encabezados de respuesta HTTP por nombre.PATH_TO_FIELD
: Es la ruta de acceso al campo en la respuesta de JSON al que deseas acceder. Puede ser solo el nombre del campo o, si el campo está anidado dentro de un objeto, puede tener el formatoobject1.object2.field
.
Por ejemplo, si una API muestra {"age":50}
y un flujo de trabajo almacena esa respuesta en una variable llamada age_response
, en el siguiente ejemplo, se muestra el valor del campo age
; en este caso, 50
:
age_response.body.age
Muestras
Estos ejemplos demuestran la sintaxis.
Asigna la respuesta de una llamada a la API
A menos que ingreses tu propio término de búsqueda, en esta muestra se usa tu ubicación de Google Cloud para construir un término de búsqueda, que pasa a la API de Wikipedia. Se muestra una lista de artículos de Wikipedia relacionados.
YAML
JSON
Realiza una solicitud POST de HTTP externa
En este ejemplo, se realiza una solicitud POST a un extremo HTTP externo.
YAML
JSON
Realiza una solicitud GET de HTTP externa con encabezados
En este ejemplo, se crea una solicitud GET HTTP con un encabezado personalizado. También puedes proporcionar definiciones de encabezados personalizados cuando realices otros tipos de solicitudes HTTP.
YAML
JSON
Usa OIDC para la autenticación cuando realices una solicitud a Cloud Functions
En este ejemplo, se realiza una solicitud HTTP con OIDC. Para ello, se agrega una sección auth
a la
sección args
de la definición del flujo de trabajo después de especificar la URL.
YAML
JSON
Detecta y maneja errores de solicitudes HTTP
En esta muestra, se implementa un controlador de excepciones personalizado basado en el código de estado HTTP que muestra la solicitud GET. El flujo de trabajo detecta una posible excepción y muestra un mensaje de error predefinido. Si no se reconoce una excepción, la ejecución del flujo de trabajo falla y arroja la excepción como lo muestra la solicitud GET. Para ver otras etiquetas de error, consulta Errores de flujo de trabajo.
YAML
JSON
¿Qué sigue?
- Instructivo para usar Workflows con Cloud Run y Cloud Functions
- Invoca un extremo privado que cumple con los Controles del servicio de VPC
- Invoca IAP local, Compute Engine, GKE o cualquier otro extremo con la habilitación de IAP
- Referencia de la sintaxis de flujos de trabajo