HTTP
El conector HTTP proporciona conectividad al servicio HTTP y consume APIs basadas en HTTP. El conector también admite la conectividad SSL/TLS mediante una configuración personalizada y varios mecanismos de autenticación, como la concesión de credenciales del cliente de OAuth 2.0, la información básica y el resumen.
Antes de comenzar
Antes de usar el conector HTTP, realiza las siguientes tareas:
- En tu proyecto de Google Cloud, haz lo siguiente:
- Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
- Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.
- Habilita los siguientes servicios:
secretmanager.googleapis.com
(API de Secret Manager)connectors.googleapis.com
(API de conectores)
Para comprender cómo habilitar servicios, consulta Habilita servicios.
Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.
Configura el conector
Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:
- En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.
- Haz clic en + Crear nueva para abrir la página Crear conexión.
- En la sección Ubicación, elige la ubicación para la conexión.
- Región: selecciona una ubicación de la lista desplegable.
Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.
- Haz clic en Siguiente.
- Región: selecciona una ubicación de la lista desplegable.
- En la sección Detalles de la conexión, completa lo siguiente:
- Conector: Selecciona HTTP en la lista desplegable de Conectores disponibles.
- Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
- En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.
Los nombres de las conexiones deben cumplir con los siguientes criterios:
- Los nombres de las conexiones pueden usar letras, números o guiones.
- Las letras deben estar en minúsculas.
- Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
- Los nombres de las conexiones no pueden superar los 63 caracteres.
- De manera opcional, ingresa una Descripción para la instancia de conexión.
- Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
- De manera opcional, configura los parámetros de nodo de conexión:
- Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
- Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.
Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.
-
Usar proxy: Selecciona la casilla de verificación para configurar un servidor proxy para la conexión.
- Haz clic en Agregar destino.
- Selecciona un Tipo de destino.
- Dirección del host: Especifica el nombre de host o la dirección IP del destino.
Si deseas establecer una conexión privada a tu backend, haz lo siguiente:
- Crea un adjunto de servicio de PSC.
- Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
- Dirección del host: Especifica el nombre de host o la dirección IP del destino.
- De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
- De manera opcional, si deseas usar SSL, selecciona Habilitar SSL. Se mostrarán los detalles de la configuración de SSL.
- Selecciona un tipo de almacén de confianza. Puede ser Público, Privado o Conexión no segura.
- Selecciona los certificados como se muestra en función de la selección del almacén de confianza.
- Si usas mTLS, selecciona los certificados del almacén de claves en la sección Almacén de claves.
- De manera opcional, selecciona la versión TLS.
- Ingresa el conjunto de algoritmos de cifrado admitido. Ingresa varios conjuntos de algoritmos de cifrado, como valores separados por comas. Para obtener más información, consulta Conjuntos de algoritmos de cifrado admitidos.
- Haz clic en Siguiente.
- En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
- Tipo de destino: Selecciona un Tipo de destino.
- En el campo Dirección de host, especifica el nombre de host o la dirección IP del destino.
- Si deseas establecer una conexión privada a tus sistemas de backend, sigue estos pasos:
- Crea un adjunto de servicio de PSC.
- Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
- Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes considerar configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir solo las direcciones IP estáticas específicas.
- Si deseas establecer una conexión privada a tus sistemas de backend, sigue estos pasos:
Para ingresar destinos adicionales, haz clic en + Agregar destino.
- En el campo Dirección de host, especifica el nombre de host o la dirección IP del destino.
- Haz clic en Siguiente.
- Tipo de destino: Selecciona un Tipo de destino.
-
En la sección Autenticación, ingresa los detalles de autenticación.
- Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.
La conexión de MongoDB admite los siguientes tipos de autenticación:
- Autenticación personalizada
- OAuth 2.0: otorgamiento de credenciales de cliente
- Autenticación básica
- Autenticación resumida
- Código de autorización de OAuth 2.0
- Cuenta de servicio
- Autenticación del token del ID de la cuenta de servicio
- Autenticación de la clave de API
- Haz clic en Siguiente.
Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.
- Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.
- Revisa: Revisa tus detalles de conexión y autenticación.
- Haz clic en Crear.
Configura la autenticación
Ingresa los detalles según la autenticación que desees usar.
- Autenticación personalizada
Los detalles de autorización personalizados se pueden agregar como un encabezado de solicitud durante la ejecución de la acción de la tarea Conectores.
- OAuth 2.0: Otorgamiento de credenciales de cliente
- ID de cliente: El ID de cliente que se usará para autenticar la solicitud HTTP.
- Secreto del cliente: Secret de Secret Manager que contiene el secreto del cliente para autenticar la solicitud HTTP.
- Formato de solicitud para el token de acceso: Es el formato de solicitud que se usará en las solicitudes realizadas para recuperar el token de acceso desde el servidor de autenticación.
Selecciona
body
para pasar el ID de cliente y el Secret como un cuerpo de solicitud oheader
a fin de pasarlos como encabezado codificado. - Ruta de acceso a la solicitud del token: Es la ruta de acceso de la solicitud que se agregará a la URL del servidor de autenticación para recuperar la URL del token de acceso.
- Hora de vencimiento predeterminada: Hora de vencimiento predeterminada (en segundos) para el token de acceso Este tiempo se usará en caso de que la respuesta del token de acceso no tenga un tiempo de vencimiento. Si no se proporciona el valor, el token se actualizará en 6 horas.
- Autenticación básica
- Username: Nombre de usuario usado para realizar una solicitud HTTP
- Contraseña: El Secret de Secret Manager que contiene la contraseña asociada con el nombre de usuario proporcionado
- Autenticación resumida
- Username: Nombre de usuario usado para realizar una solicitud HTTP
- Contraseña: El Secret de Secret Manager que contiene la contraseña asociada con el nombre de usuario proporcionado
- Código de autorización de OAuth 2.0
- ID de cliente: Es el ID de cliente que proporciona tu aplicación externa.
- Alcances: Son los permisos de permisos que admite tu aplicación externa.
- Secreto del cliente: Selecciona el secreto de Secret Manager. Debes crear el secreto de Secret Manager antes de configurar esta autorización.
- Versión del secreto: La versión del secreto de Secret Manager para el secreto del cliente.
- De manera opcional, puedes habilitar PKCE (clave de prueba para el intercambio de código) si tu servidor de backend lo admite.
- Authorization URL: Ingresa la URL de autorización de la aplicación externa.
- URL del token de acceso: Ingresa la URL para obtener el token de acceso de la aplicación externa.
- Cuenta de servicio
Selecciona esta opción para autenticarte con la cuenta de servicio que proporcionaste en los pasos anteriores cuando configuraste esta conexión. Asegúrate de haberle proporcionado a la cuenta de servicio los roles y los permisos de IAM relevantes necesarios para la autenticación.
- Permisos: Ingresa los permisos de acceso separados por comas que necesites. Para obtener más información, consulta Permisos de acceso.
- Autenticación del token del ID de la cuenta de servicio
Selecciona esta opción para autenticarte con el token de ID generado a partir de la cuenta de servicio que proporcionaste en los pasos anteriores. Esta autenticación usa tokens web JSON (JWT) para la autenticación. El proveedor de tokens de ID firma y emite los JWT para la autenticación con una cuenta de servicio.
- Público: Ingresa los destinatarios a los que está destinado el JWT.
- Header Name: Ingresa el nombre del encabezado del token de ID generado que se usará en el encabezado HTTP. Si no especificas ningún valor para este campo, el valor de la clave se establece en
Authorization
de forma predeterminada.
- Autenticación de la clave de API
Selecciona esta opción para autenticar con una clave de API.
- Clave de API: Selecciona el secreto de Secret Manager de la clave de API.
- Versión del secreto: Selecciona la versión del secreto.
- Nombre del parámetro de la clave de API: Ingresa un nombre de parámetro para la clave de API. Una clave de API se envía a tu servidor de backend como un par clave-valor. El valor que ingreses aquí se usará como el nombre de la clave de API que seleccionaste anteriormente.
- Ubicación de la clave de API: Selecciona dónde quieres agregar la clave de API en la solicitud.
Para el tipo de autenticación Authorization code
, después de crear la conexión, debes realizar algunos pasos adicionales a fin de configurar la autenticación. Para obtener más información, consulta Pasos adicionales después de la creación de la conexión.
Conjuntos de algoritmos de cifrado admitidos
Versión de TLS | Conjuntos de algoritmos de cifrado admitidos |
---|---|
1.2 |
|
1.3 |
|
Pasos adicionales después de la creación de la conexión
Si seleccionaste OAuth 2.0 - Authorization code
para la autenticación, debes seguir estos pasos adicionales después de crear la conexión:
- En la página Conexiones, busca la conexión recién creada.
Ten en cuenta que el Status para el conector nuevo será Authorization required.
- Haz clic en Se requiere autorización.
Se mostrará el panel Editar autorización.
- Copia el valor de URI de redireccionamiento a la aplicación externa.
- Verifica los detalles de la autorización.
- Haz clic en Autorizar.
Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.
Volver a autorizar el código de autorización
Si estás usando el tipo de autenticación Authorization code
y realizaste algún cambio en la configuración de tu aplicación HTTP de backend, debes volver a autorizar tu conexión HTTP. Para volver a autorizar una conexión, sigue estos pasos:
- Haz clic en la conexión requerida en la página Conexiones.
Se abrirá la página de detalles de la conexión.
- Haz clic en Editar para editar los detalles de la conexión.
- Verifica los detalles de OAuth 2.0 - Código de autorización en la sección Autenticación.
Si es necesario, realiza los cambios necesarios.
- Haz clic en Guardar. Esta acción te llevará a la página de detalles de la conexión.
- Haz clic en Editar autorización en la sección Autenticación. Esto muestra el panel Autorizar.
- Haz clic en Autorizar.
Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.
Entidades, operaciones y acciones
Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.
- Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.
Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista
Entities
estará vacía. - Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones no compatibles no aparecerán en la lista
Operations
. - Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista
Actions
estará vacía.
Limitaciones del sistema
El conector HTTP puede procesar 100 transacciones por segundo por nodo y limita cualquier transacción que supere este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) a una conexión.
Para obtener más información sobre los límites aplicables a Integration Connectors, consulta Límites.
Acciones admitidas
El conector HTTP admite las siguientes acciones:
Acción HttpRequest
En las siguientes tablas, se describen los parámetros de entrada y salida de la acción HttpRequest.
Parámetros de entrada de la acción de HttpRequest
Nombre del parámetro | Tipo de datos | Requeridos | Descripción |
---|---|---|---|
URL | Estructural | No | La URL a la que deseas enviar la solicitud.
La URL tiene el formato <scheme>://<netloc>/<path>;<params>?<query>#<fragment> .
Si proporcionas netloc , se anula el nombre de host proporcionado durante la creación de la conexión. |
Método | String | No | Método de solicitud HTTP como GET, POST, DELETE o PUT. El valor predeterminado es GET. |
Encabezados | Estructural | No | Encabezados de solicitud HTTP. |
Cuerpo | String | No | Cuerpo de la solicitud HTTP. |
RequestHasBytes | Booleano | No | Indica si se debe enviar la solicitud como bytes. Si se configura como true , debes enviar la solicitud como una string codificada en Base64 en el parámetro Body . El valor predeterminado es false . |
ResponseHasBytes | Booleano | No | Indica si se debe recibir la respuesta como bytes. Si se configura como true , recibirás la respuesta como una cadena codificada en Base64 en el parámetro de salida ResponseBody . El valor predeterminado es false . |
HttpVersion | String | No | La versión HTTP que se usará para realizar una solicitud. Los valores admitidos son 1.1 y 2. Si especificas la versión 2, se realiza la negociación ALPN (Negociación del protocolo de la capa de aplicación) y la versión 1.1 se usará si el servidor no es compatible con la versión 2. El valor predeterminado es 2. |
ResponseFormat | String | No | Especifica el formato de la respuesta del conector. Los valores admitidos son v1 y v2 .
El valor predeterminado es v1 .
Respuesta de muestra de la versión 1: [{ "ResponseBody": "{\n \"status\": 200\n}" }, { "StatusCode": 200.0 }, { "HttpVersion": "2" }, { "ResponseHeaders": { ":status": "200", "content-length": "19" } }] Respuesta de muestra de la versión 2: [{ "ResponseBody": "{\n \"status\": 200\n}", "StatusCode": 200.0, "HttpVersion": "2", "ResponseHeaders": { ":status": "200", "content-length": "19" } }] |
FailOnError | Booleano | No | Especifica el comportamiento de la conexión cuando hay un error en tu aplicación de backend.
El valor predeterminado es |
Parámetros de resultado de la acción HttpRequest
Nombre del parámetro | Tipo de dato | Descripción |
---|---|---|
ResponseBody | Cadena | Respuesta recibida del servidor HTTP. |
StatusCode | Integer | Código de estado recibido del servidor HTTP. |
HttpVersion | String | Versión negociada para la solicitud HTTP. |
ResponseHeaders | Estructural | Encabezados de respuesta HTTP en forma de pares key,value . |
Ejemplos
En los ejemplos de esta sección, se describen las siguientes operaciones:
- Configura una carga útil de solicitud
- Enviar contenido de bytes
- Obtener contenido de bytes
En la siguiente tabla, se enumeran las situaciones de muestra y la configuración correspondiente en la tarea de conectores:
Tarea | Configuración |
---|---|
Configura una carga útil de solicitud |
En este ejemplo, se realiza una solicitud POST a la URL |
Enviar contenido de bytes |
Para enviar contenido de bytes (como archivos), debes establecer el atributo de la solicitud
En este ejemplo, se realiza una solicitud POST al servidor |
Obtener contenido de bytes |
Para obtener bytes (como una string Base64) del servidor, debes configurar el atributo de solicitud
En este ejemplo, se realiza una solicitud GET al servidor |
Códigos de error
En esta sección, se descartan los mensajes de error que puedes recibir cuando usas la conexión HTTP.
Mensaje de error | Causa |
---|---|
Error de conexión con el servidor HTTP | La conexión HTTP no pudo establecer la conexión con el servidor debido a una falla del protocolo de enlace SSL o a un extremo incorrecto del servidor HTTP. |
Respuesta de error recibida del servidor HTTP | El servidor HTTP que intentas conectar muestra una respuesta de error con código de estado 4xx o 5xx. Respuesta de muestra:
{ "error": { "code": 400, "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "metadata": { "Body": "{\"thisIsResponseJSON\":\"someValue\"}" "Error": "Error response received from the HTTP server", "Headers": "{\":status\":[\"400\"], \"access-control-allow-credentials\":[\"true\"]}", "StatusCode": "400", "connection_type": "Http" } } ], "message": "Unable to execute HTTP Request", "status": "FAILED_PRECONDITION" } } |
Se produjo un error cuando se recuperaba el token de acceso | Se produjo un error cuando se recuperaba el token de acceso para el tipo de autenticación OAuth Client Credentials Grant . |
Error de autenticación del resumen | El entorno de ejecución del conector no recibió un desafío de resumen o el desafío es de un tipo no compatible. |
Usa Terraform para crear conexiones
Puedes usar el recurso de Terraform para crear una conexión nueva.Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.
Si quieres ver una plantilla de muestra de Terraform para crear conexiones, consulta la plantilla de muestra.
Cuando creas esta conexión en Terraform, debes establecer las siguientes variables en tu archivo de configuración de Terraform:
Nombre del parámetro | Tipo de datos | Requeridos | Descripción |
---|---|---|---|
proxy_enabled | BOOLEAN | Falso | Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión. |
Usa la conexión HTTP en una integración
Después de crear la conexión, estará disponible en Apigee Integration y en Application Integration. Puedes usar la conexión en una integración mediante la tarea Conectores.
- Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta la Tarea Conectores.
- Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la tarea Conectores.
Obtén ayuda de la Comunidad de Google Cloud
Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.¿Qué sigue?
- Comprende cómo suspender y reanudar una conexión.
- Descubre cómo supervisar el uso de los conectores.
- Descubre cómo ver los registros del conector.