FTP

El conector FTP te permite conectarte a un servidor FTP y realizar operaciones de transferencia de archivos.

Antes de empezar

Antes de usar el conector FTP, haz lo siguiente:

  • En tu proyecto de Google Cloud:
    • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
    • Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
    • Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crearla. El conector y la cuenta de servicio deben pertenecer al mismo proyecto. Para obtener más información, consulta el artículo Crear una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para saber cómo habilitar servicios, consulta Habilitar servicios.

    Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.

Configurar el conector

Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.

    Ve a la página Conexiones.

  2. Haga clic en + Crear para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación de la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, haz lo siguiente:
    1. Conector: selecciona FTP en la lista desplegable de conectores disponibles.
    2. Versión del conector: seleccione la versión del conector en la lista desplegable de versiones disponibles.
    3. En el campo Connection Name (Nombre de conexión), introduce un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir los siguientes criterios:

      • Los nombres de conexión pueden contener letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
      • Los nombres de conexión no pueden tener más de 49 caracteres.
    4. Si quiere, puede introducir una Descripción para la instancia de conexión.
    5. También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es Error.
    6. Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
    7. Si quieres, configura los ajustes del nodo de conexión:

      • Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
      • Número máximo de nodos: introduce el número máximo de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo influyen los nodos en el precio de tu conector, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.

    8. Profundidad de recuperación de archivos: especifica el nivel de profundidad de las carpetas que quieres consultar en la tabla Root.
    9. Pasivo: controla si se dirige el servidor al modo pasivo. Se recomienda si está detrás de un cortafuegos.
    10. Ruta remota: la ruta actual en el servidor FTP.
    11. Modo SSL: el mecanismo de autenticación que se usará al conectarse al servidor FTP.
    12. Profundidad de la tabla: el nivel de profundidad para mostrar las subcarpetas como vistas.
    13. Usar MLSD: usa las fichas para el procesamiento automático. Se usa solo para servidores FTP.
    14. También puedes hacer clic en + Añadir etiqueta para añadir una etiqueta a la conexión en forma de par clave-valor.
    15. Haz clic en Siguiente.
  5. En la sección Destinations (Destinos), introduce los detalles del host remoto (sistema backend) al que quieras conectarte.
    1. Tipo de destino: selecciona un Tipo de destino.
      • Para especificar el nombre de host o la dirección IP de destino, selecciona Dirección de host y introduce la dirección en el campo Host 1.
      • Para establecer una conexión privada, selecciona Endpoint attachment (Endpoint adjunto) y elige el adjunto que quieras de la lista Endpoint Attachment (Endpoint adjunto).

      Si quieres establecer una conexión pública con tus sistemas backend con seguridad adicional, puedes configurar direcciones IP de salida estáticas para tus conexiones y, a continuación, configurar las reglas de tu cortafuegos para que solo se permitan las direcciones IP estáticas específicas.

      Para introducir más destinos, haga clic en + Añadir destino.

    2. Haz clic en Siguiente.
  6. En la sección Autenticación, introduce los detalles de autenticación.
    1. Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.

      La conexión FTP admite los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña

      2. Para saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.

    2. Haz clic en Siguiente.
  7. Revisar: revisa los detalles de la conexión y la autenticación.
  8. Haz clic en Crear.

Configurar la autenticación

Introduce los detalles en función de la autenticación que quieras usar.

  • Nombre de usuario y contraseña
    • Nombre de usuario: nombre de usuario de FTP que se usará para la conexión.
    • Contraseña: secreto de Secret Manager que contiene la contraseña asociada al nombre de usuario de FTP.

Entidades, operaciones y acciones

Todos los conectores de integración 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 te muestra como entidades, operaciones y acciones.

  • Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

    Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista Entities estará vacía.

  • Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

  • Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. 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 FTP puede procesar 1 transacción por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Acciones

En esta sección se enumeran algunas de las acciones que admite el conector. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

Acción de subida

En la siguiente tabla se describen los parámetros de entrada de la acción Upload.

Nombre del parámetro Tipo de datos Obligatorio Descripción
Contenido Cadena No Contenido que se va a subir como archivo.
ContentBytes Cadena No Contenido de bytes (como una cadena Base64) que se va a subir como archivo. Úsalo para subir datos binarios.
HasBytes Booleano No Especifica si el contenido se debe subir como bytes. El valor predeterminado es false.
RemoteFile Cadena Sí Nombre del archivo en el host remoto.
Sobrescribir Booleano No Especifica si se debe sobrescribir el archivo remoto. El valor predeterminado es false.

Para ver ejemplos de cómo configurar la acción Upload, consulta Ejemplos.

Descargar acción

En la siguiente tabla se describen los parámetros de entrada de la acción Download.

Nombre del parámetro Tipo de datos Obligatorio Descripción
RemoteFile Cadena Sí Nombre del archivo en el host remoto.
HasBytes Booleano No Especifica si el contenido se debe descargar como bytes. El valor predeterminado es false.

Para ver ejemplos de cómo configurar la acción Download, consulta Ejemplos.

Acción MoveFile

En la siguiente tabla se describen los parámetros de entrada de la acción MoveFile.

Nombre del parámetro Tipo de datos Obligatorio Descripción
RemoteFile Cadena Sí Ruta del archivo remoto que se va a mover.
DestinationPath Cadena Sí La nueva ruta a la que quieres mover el archivo.

Para ver ejemplos de cómo configurar la acción MoveFile, consulta Ejemplos.

Acción RenameFile

En la siguiente tabla se describen los parámetros de entrada de la acción RenameFile.

Nombre del parámetro Tipo de datos Obligatorio Descripción
RemoteFile Cadena Sí Ruta y nombre del archivo remoto que se va a cambiar.
NewFileName Cadena Sí Nuevo nombre del archivo remoto.

Para ver ejemplos de cómo configurar la acción RenameFile, consulta Ejemplos.

Ejemplos

En esta sección se describe cómo realizar algunas de las operaciones y acciones de entidades en este conector. En los ejemplos se describen las siguientes operaciones:

  • Lista todos los archivos del directorio raíz
  • Mostrar los archivos que coinciden con un patrón en un directorio
  • Mover un archivo
  • Cambiar el nombre de un archivo
  • Eliminar un archivo
  • Subir un archivo de texto ASCII
  • Subir un archivo binario
  • Descargar un archivo de texto ASCII
  • Descargar un archivo binario

En la siguiente tabla se muestran los ejemplos de situaciones y la configuración correspondiente en la tarea Conectores:

Tarea Comando de ejemplo Configuración
Lista todos los archivos del directorio raíz ls /
  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona la entidad Root y, a continuación, la operación List.
  3. Haz clic en Listo.
Mostrar los archivos .csv de un directorio ls /tmp/*.csv
  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona el directorio base (/tmp) en la lista Entity.
  3. Selecciona la operación List y, a continuación, haz clic en Hecho.
  4. Define la cláusula de filtro. Para definir la cláusula, en la sección Entrada de tarea de la tarea Conectores, haga clic en filterClause y, a continuación, introduzca FilePath LIKE '/tmp/%.csv' en el campo Valor predeterminado.
Mover un archivo mv /tmp/dir_A/hello_world.txt /dir_B/dir_C/
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción MoveFile y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value: 
    {
"RemoteFile": "/tmp/dir_A/hello_world.txt",
"DestinationPath": "/dir_B/dir_C/"
}

En este ejemplo, se mueve el archivo /tmp/dir_A/hello_world.txt al directorio /dir_B/dir_C/. Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

[{
"Success":"true"
}]
Cambiar el nombre de un archivo mv /tmp/hello_world.txt /tmp/hello_world_new.txt
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción RenameFile y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value: 
    {
"RemoteFile": "/tmp/hello_world.txt",
"NewFilename": "hello_world_new.txt"
}

En este ejemplo se cambia el nombre del archivo hello_world.txt a hello_world_new.txt. Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

[{
"Success":"true"
}]
Eliminar un archivo rm /tmp/myfile.csv
  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. En la lista Entity, selecciona el directorio base que contenga el archivo que quieras mover.
  3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
  4. Asigna el ID de entidad a la ruta completa del archivo. Para definir el ID de entidad, en la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y, a continuación, introduce /tmp/myfile.csv en el campo Valor predeterminado.

    También puede definir filterClause en FilePath LIKE '/tmp/myfile.csv' en lugar de especificar entityId.
Subir un archivo de texto ASCII put file_1.txt /tmp/file_1.txt
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción Upload y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haga clic en connectorInputPayload y, a continuación, introduzca lo siguiente en el campo Default Value: 
    {
  "Content": "This is a sample text!\r\n",
  "RemoteFile": "/tmp/file_1.txt",
  "Overwrite": true
}

    4. En este ejemplo se crea el archivo file_1.txt, que tiene el contenido This is a sample text!, en el directorio /tmp del servidor FTP. Además, se sobrescribe cualquier archivo que ya tenga ese nombre, ya que el valor del atributo Overwrite es true.

    El atributo Overwrite es opcional. De forma predeterminada, el valor es false.

Subir un archivo binario put image_1.png /tmp/image_1.png Para subir contenido binario, primero debes codificarlo en formato Base64. Puedes elegir la herramienta que quieras para codificar el contenido. Los pasos para codificar el contenido no se incluyen en este documento. Una vez que tengas el contenido como una cadena Base64, sigue estos pasos:
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción Upload y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haga clic en connectorInputPayload y, a continuación, introduzca lo siguiente en el campo Default Value: 
    {
  "ContentBytes": "SGVsbG8gd29ybGQ=",
  "RemoteFile": "/tmp/image_1.png",
  "Overwrite": true,
  "HasBytes": true
}

    4. En este ejemplo se crea el archivo image_1.png con el contenido especificado en el campo ContentBytes. El archivo se crea en el directorio /tmp del servidor FTP. Además, se sobrescribe cualquier archivo que ya tenga ese nombre, ya que el valor del atributo Overwrite es true.

    El atributo Overwrite es opcional. De forma predeterminada, el valor es false.

Descargar un archivo de texto ASCII get /tmp/myfile.txt
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción Download y, a continuación, haga clic en Hecho.
  3. En la sección Salida de la tarea de la tarea Conectores, haga clic en connectorInputPayload y, a continuación, introduzca lo siguiente en el campo Default Value: 
    {
"RemoteFile": "/tmp/myfile.txt"
}

El contenido del archivo descargado está disponible como una cadena en el campo Content del parámetro de respuesta connectorOutputPayload de la tarea del conector.

Descargar un archivo binario get /tmp/myfile.png
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción Download y, a continuación, haga clic en Hecho.
  3. En la sección Salida de la tarea de la tarea Conectores, haga clic en connectorInputPayload y, a continuación, introduzca lo siguiente en el campo Default Value: 
    {
"RemoteFile": "/tmp/myfile.png",
"HasBytes" : true
}

El contenido del archivo descargado está disponible como una cadena codificada en Base64 en el campo ContentBytes del parámetro de respuesta connectorOutputPayload de la tarea del conector.

Esquema JSON de la carga útil

Todos los objetos de entidad de una conexión FTP tienen un esquema JSON predefinido. Si conoces bien el esquema, puedes configurar fácilmente los valores de la carga útil de entrada o salida. Los objetos de entidad de una conexión FTP usan el siguiente esquema JSON:

  {
    "type": "object",
    "properties": {
      "FilePath": {
        "type": "string",
        "readOnly": false
      },
      "Filename": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false,
        "description": "The name of the file or directory."
      },
      "FileSize": {
        "type": [
          "number",
          "null"
        ],
        "readOnly": false,
        "description": "The size of the file."
      },
      "LastModified": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "IsDirectory": {
        "type": [
          "boolean",
          "null"
        ],
        "readOnly": false
      },
      "Permissions": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "Owner": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "OwnerId": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "Group": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      },
      "GroupId": {
        "type": [
          "string",
          "null"
        ],
        "readOnly": false
      }
    }
  }

Configuración dinámica de filterClause

En las operaciones List, Update y Delete, puede definir el valor de la variable de entrada filterClasue de forma dinámica en el tiempo de ejecución mediante la tarea Asignación de datos de su integración. Por ejemplo, puede que quieras enviar el valor de la cláusula de filtro cuando invoques el activador de la API en tu integración. En la siguiente imagen se muestra una asignación de ejemplo de la variable filterClause en el editor de asignación de datos de la tarea de asignación de datos: Definir una cláusula de filtro en el editor de asignación de datos

Crear conexiones con Terraform

Puedes usar el recurso de Terraform para crear una conexión.

Para saber cómo aplicar o quitar una configuración de Terraform, consulta Comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para crear una conexión, consulta la plantilla de ejemplo.

Cuando crees esta conexión con Terraform, debes definir las siguientes variables en el archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Obligatorio Descripción
file_retrieval_depth STRING Falso Especifica el nivel de profundidad de las carpetas que quieras consultar en la tabla Root.
pasiva BOOLEAN Falso Controla si se debe dirigir el servidor al modo pasivo. Se recomienda si está detrás de un cortafuegos.
remote_path STRING Falso La ruta actual en el servidor FTP.
table_depth INTEGER Falso El nivel de profundidad para mostrar las subcarpetas como vistas.
use_mlsd BOOLEAN Falso Usa fichas para el procesamiento automático. Se usa solo para servidores FTP.

Usar la conexión FTP en una integración

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

  • Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.

Obtener ayuda de la comunidad de Google Cloud

Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.

Siguientes pasos