SFTP

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

Antes de comenzar

En tu proyecto de Google Cloud, realiza las siguientes tareas:

  • Asegúrate de que la conectividad de red esté configurada. Para obtener más información, consulta Conectividad de red.
  • Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
  • Otorga los roles de IAM roles/secretmanager.viewer y roles/secretmanager.secretAccessor a la cuenta de servicio que deseas usar para el conector.
  • Habilita secretmanager.googleapis.com (API de Secret Manager) y connectors.googleapis.com (API de Connectors). Para obtener más información, consulta Cómo habilitar servicios.

Crea una conexión SFTP

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, haz lo siguiente:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
  3. En la sección Ubicación, selecciona una ubicación de la lista Región y, luego, haz clic en Siguiente.

    Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. En el campo Conector, selecciona SFTP.
    2. En el campo Versión del conector, selecciona la versión deseada.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión. El nombre de la conexión puede contener letras minúsculas, números o guiones. El nombre debe comenzar con una letra y terminar con una letra o un número, y no debe exceder los 49 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
    6. En el campo Cuenta de servicio, selecciona una cuenta que tenga los roles necesarios.
    7. (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, de forma predeterminada, el mínimo de nodos se establece en 2 (para una mejor disponibilidad) y el máximo en 50.
    8. (Opcional) En el campo Ruta remota, ingresa la ruta de acceso a la carpeta en el servidor de SFTP para realizar las operaciones de la entidad, como List, Create, Update o Delete.

      9. Si accedes a entidades (archivos o carpetas) en la carpeta raíz o en las carpetas secundarias inmediatas de la carpeta raíz, no es necesario que establezcas ningún valor para este campo. Sin embargo, si deseas acceder a entidades anidadas que se encuentran a una profundidad de 2 niveles o más desde la carpeta raíz, debes establecer el valor de este campo en la ruta de acceso base de la carpeta que tiene las entidades a las que deseas acceder. Por ejemplo, si quieres acceder al archivo /folder_A/folder_B/folder_C/test.png, debes establecer la ruta de acceso remota en /folder_A/folder_B/folder_C.

    9. De forma opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
    10. Haz clic en Siguiente.
  5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte y haz clic en Siguiente.

    6. En el campo Tipo de destino, selecciona el tipo que desees:

    • Para especificar el nombre de host o la dirección IP de destino, selecciona Dirección de host y, luego, ingresa la dirección en el campo Host 1.
    • Para establecer una conexión privada, selecciona Adjunto de extremo y elige el adjunto requerido de la lista Adjunto de extremo.

    Si deseas establecer una conexión pública con tus sistemas de backend con seguridad adicional, puedes configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para permitir solo las direcciones IP estáticas específicas.

  6. En la sección Autenticación, selecciona un Tipo de autenticación, ingresa los detalles pertinentes y haz clic en Siguiente.

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

    • Nombre de usuario y contraseña
    • SSH_PUBLIC_KEY

    Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

  7. Revisa los detalles de conexión y autenticación, y, luego, haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • Nombre de usuario y contraseña
    • Nombre de usuario: El nombre de usuario de SFTP que se usará para la conexión.
    • Contraseña: El Secret de Secret Manager que contiene la contraseña asociada con el nombre de usuario de SFTP.
  • SSH_PUBLIC_KEY
    • Nombre de usuario: La cuenta de usuario de SFTP que se usa para realizar la autenticación.
    • Clave privada SSH: Clave privada para la autenticación SSH.
    • Contraseña de clave privada SSH: Frase de contraseña o contraseña que protege la clave privada, si la hay.
    • Tipo de clave privada SSH: Formato de la clave privada.

Usa la conexión SFTP 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 a través de la tarea Connectors.

  • Para comprender cómo crear y usar la tarea Connectors en Apigee Integration, consulta Tarea Connectors.
  • Para comprender cómo crear y usar la tarea Connectors en Application Integration, consulta Tarea Connectors.

Acciones

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

Acción de carga

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 String No Es el contenido que se subirá como un archivo.
ContentBytes String No Contenido de bytes (como una cadena en Base64) para subir como un archivo. Úsalo para subir datos binarios.
HasBytes Booleano No Especifica si el contenido se debe subir como bytes. El valor predeterminado es false.
RemoteFile String Sí Nombre del archivo en el host remoto.
Reemplazar Booleano No Especifica si se debe reemplazar el archivo remoto. El valor predeterminado es false.

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

Acción de descarga

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 String 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 sobre 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 String Sí Es la ruta del archivo remoto que se moverá.
DestinationPath String Sí Es la nueva ruta de acceso a la que deseas mover el archivo.

Para ver ejemplos sobre 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 String Sí Ruta de acceso y nombre del archivo remoto al que se le cambiará el nombre.
NewFileName String Sí Es el nombre nuevo del archivo remoto.

Para ver ejemplos sobre 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 la entidad en este conector. En los ejemplos, se describen las siguientes operaciones:

  • Cómo enumerar todos los archivos en el directorio raíz
  • Enumerar los archivos que coinciden con un patrón en un directorio
  • Cómo mover un archivo
  • Cómo cambiar el nombre a un archivo
  • Cómo borrar un archivo
  • Cómo subir un archivo de texto ASCII
  • Cómo subir un archivo binario
  • Cómo descargar un archivo de texto ASCII
  • Cómo descargar un archivo binario
  • Descarga varios archivos

En la siguiente tabla, se enumeran las situaciones de muestra y la configuración correspondiente en la tarea de conectores:

Tarea Comando de muestra Configuración
Cómo enumerar todos los archivos en el directorio raíz ls /
  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona la entidad Root y, luego, la operación List.
  3. Haz clic en Listo.
Enumera 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) de la lista Entity.
  3. Selecciona la operación List y haz clic en Listo.
  4. Establece la cláusula de filtro. Para establecer la cláusula, en la sección Task Input de la tarea Connectors, haz clic en filterClause y, luego, ingresa FilePath LIKE '/tmp/%.csv' en el campo Valor predeterminado.
Cómo 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. Selecciona la acción MoveFile y haz clic en Listo.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en 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/. Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

[{
"Success":"true"
}]
Cómo cambiar el nombre a 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. Selecciona la acción RenameFile y haz clic en Listo.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en 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. Si ejecutas este ejemplo, se mostrará una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

[{
"Success":"true"
}]
Cómo borrar 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 tiene el archivo que se moverá.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. Configura el ID de la entidad en la ruta completa del archivo. Para establecer el ID de la entidad, en la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa /tmp/myfile.csv en el campo Valor predeterminado.

    Como alternativa, en lugar de especificar entityId, también puedes establecer filterClause en FilePath LIKE '/tmp/myfile.csv'.
Cómo 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. Selecciona la acción Upload y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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 de SFTP. Además, se reemplazará cualquier archivo existente con el mismo nombre porque el valor del atributo Overwrite es true.

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

Cómo subir un archivo binario put image_1.png /tmp/image_1.png Para subir un contenido binario, primero debes codificar el contenido en el formato Base64. Puedes elegir una herramienta de tu elección para codificar el contenido. Los pasos para codificar el contenido están fuera del alcance de este documento. Una vez que el contenido sea una string Base64, realiza los siguientes pasos:
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción Upload y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa lo siguiente en el campo Default Value: 
    {
  "ContentBytes": "SGVsbG8gd29ybGQ=",
  "RemoteFile": "/tmp/image_1.png",
  "Overwrite": true,
  "HasBytes": true
}

    4. En esta muestra, se crea el archivo image_1.png con el contenido como se especifica en el campo ContentBytes. El archivo se crea en el directorio /tmp del servidor SFTP. Además, se reemplazará cualquier archivo existente con el mismo nombre porque el valor del atributo Overwrite es true.

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

Cómo 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. Selecciona la acción Download y haz clic en Listo.
  3. En la sección Task Output de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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.

Cómo descargar un archivo binario get /tmp/myfile.png
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción Download y haz clic en Listo.
  3. En la sección Task Output de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa 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.

Descarga varios archivos
  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción Download y haz clic en Listo.
  3. En la sección Task Output de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa lo siguiente en el campo Default Value: 
    {
"RemoteFile": "/tmp/myfile*.txt"
}

Limitaciones del sistema

El conector SFTP 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 una mejor disponibilidad) a una conexión.

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

Crea conexiones con Terraform

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.

Para ver una plantilla de Terraform de ejemplo para la creación de conexiones, consulta la plantilla de ejemplo.

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

Nombre del parámetro Tipo de datos Obligatorio Descripción
remote_path STRING Falso Es la ruta actual en el servidor SFTP.

Esquema JSON para la carga útil

Todos los objetos de entidad de una conexión de SFTP tienen un esquema JSON predefinido. Los objetos de entidad en una conexión SFTP 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
        }
      }
    }

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?