SFTP

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

Antes de comenzar

Antes de usar el conector de SFTP, 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:

  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, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

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

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona SFTP en la lista desplegable de conectores disponibles.
    2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. 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.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    6. 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.

    7. Ruta de acceso remota: Es la ruta de acceso a la carpeta en el servidor SFTP.

      Considera configurar este campo solo si deseas realizar cualquiera de las operaciones de entidades como List, Create, Update o Delete.

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

    8. De manera opcional, haz clic en + Agregar etiqueta (+ Add label) para agregar una etiqueta a la conexión en forma de par clave-valor.
    9. Haz clic en Siguiente.
  5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
    1. Tipo de destino: Selecciona un Tipo de destino.
      1. En el campo Dirección de host, especifica el nombre de host o la dirección IP del destino.
        1. Si deseas establecer una conexión privada a tus sistemas de backend, sigue estos pasos:
          1. Crea un adjunto de servicio de PSC.
          2. Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
        2. 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.

      Para ingresar destinos adicionales, haz clic en +Agregar destino.

    2. Haz clic en Siguiente.
  6. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

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

      • Nombre de usuario y contraseña
      • SSH_PUBLIC_KEY

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

    2. Haz clic en Siguiente.
  7. Revisa: Revisa tus detalles de conexión y autenticación.
  8. 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.

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 SFTP puede procesar 1 transacción por segundo por nodo y regula 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

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.

Subir acción

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

Nombre del parámetro Tipo de datos Requeridos Descripción
Temario String No Contenido para subir como archivo.
ContentBytes String No Contenido de bytes (como una string Base64) que se 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í El 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 Requeridos Descripción
RemoteFile String Sí El nombre del archivo en el host remoto.
HasBytes Booleano No Especifica si el contenido debe descargarse 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 Requeridos Descripción
RemoteFile String Sí La ruta del archivo remoto que se moverá.
DestinationPath String Sí La ruta de acceso nueva 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 Requeridos Descripción
RemoteFile String Sí Ruta de archivo y nombre remotos a los que se les cambiará el nombre.
NewFileName String Sí 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
  • Descarga un archivo binario

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/. Ejecutar este ejemplo muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea 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. Ejecutar este ejemplo muestra una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea 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 string en el campo Content del parámetro de respuesta connectorOutputPayload de la tarea del conector.

Descarga 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 string codificada en Base64 en el campo ContentBytes del parámetro de respuesta connectorOutputPayload de la tarea del conector.

Esquema JSON para la carga útil

Todos los objetos de entidad de una conexión de SFTP tienen un esquema JSON predefinido. Una vez que comprendas el esquema, podrás configurar con facilidad los valores de carga útil de entrada o salida. 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
      }
    }
  }

Configuración dinámica de filterClause

Para las operaciones List, Update y Delete, puedes configurar el valor de la variable de entrada filterClause de forma dinámica en el entorno de ejecución mediante la tarea Asignación de datos en tu integración. Por ejemplo, es posible que desees 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 un ejemplo de asignación para la variable filterClause en el editor de asignación de datos de la tarea de asignación de datos: establecer una cláusula de filtro en el editor de asignación de datos

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
remote_path STRING Falso La ruta de acceso actual en el servidor SFTP.

Cómo usar 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 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?