SFTP
Com o conector SFTP, você pode se conectar a um servidor SFTP e realizar operações de transferência de arquivos.
Antes de começar
Antes de usar o conector SFTP, faça o seguinte:
- No seu projeto do Google Cloud, faça o seguinte:
- Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
- Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.
- Ative os seguintes serviços:
secretmanager.googleapis.com
(API Secret Manager)connectors.googleapis.com
(API Connectors)
Para entender como ativar os serviços, consulte Como ativar serviços.
Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.
Configurar o conector
Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:
- No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
- Clique em + Criar novo para abrir a página Criar conexão.
- Na seção Local, escolha o local da conexão.
- Região: selecione um local na lista suspensa.
Para conferir a lista de todas as regiões com suporte, consulte Locais.
- Clique em Próxima.
- Região: selecione um local na lista suspensa.
- Na seção Detalhes da conexão, faça o seguinte:
- Conector: selecione SFTP na lista suspensa de conectores disponíveis.
- Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
- No campo Nome da conexão, insira um nome para a instância de conexão
Os nomes de conexão precisam atender aos seguintes critérios:
- Os nomes de conexões podem usar letras, números ou hifens.
- As letras precisam ser minúsculas.
- Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
- Os nomes das conexões não podem ter mais de 49 caracteres.
- Como opção, insira uma Descrição para a instância de conexão.
- Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como
Error
. - Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
- Opcionalmente, defina as Configurações do nó de conexão:
- Número mínimo de nós: digite o número mínimo de nós de conexão.
- Número máximo de nós: digite o número máximo de nós de conexão.
Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.
-
Caminho remoto: caminho da pasta no servidor SFTP.
Defina esse campo apenas se quiser realizar alguma das operações de entidade, como
List
,Create
,Update
ouDelete
.Se você estiver acessando entidades (arquivos ou pastas) na pasta raiz ou nas pastas filhas imediatas da raiz, não será necessário definir nenhum valor para esse campo. No entanto, se você quiser acessar entidades aninhadas que estão presentes a uma profundidade de dois níveis ou mais da pasta raiz, defina o valor desse campo como o caminho de base da pasta que tem as entidades que você quer acessar. Por exemplo: se você quiser acessar o arquivo
/folder_A/folder_B/folder_C/test.png
, defina o caminho remoto como/folder_A/folder_B/folder_C
. - Outra opção é clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
- Clique em Próxima.
- Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
- Tipo de destino: selecione um Tipo de destino.
- Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
- Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.
Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.
Para inserir outros destinos, clique em +Adicionar destino.
- Clique em Próxima.
- Tipo de destino: selecione um Tipo de destino.
-
Na seção Autenticação, insira os detalhes da autenticação.
- Selecione um Tipo de autenticação e insira os detalhes relevantes.
A conexão SFTP oferece suporte aos seguintes tipos de autenticação:
- Nome de usuário e senha
- SSH_PUBLIC_KEY
- Clique em Next.
Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.
- Selecione um Tipo de autenticação e insira os detalhes relevantes.
- Revisão: revise os detalhes de conexão e autenticação.
- Clique em Criar.
Configurar a autenticação
Digite os detalhes com base na autenticação que você quer usar.
-
Nome de usuário e senha
- Nome de usuário: o nome de usuário do SFTP a ser usado para a conexão.
- Senha: o Secret do Secret Manager que contém a senha associada ao nome de usuário do SFTP.
-
SSH_PUBLIC_KEY
- Nome de usuário: a conta de usuário do SFTP usada para autenticação.
- Chave privada SSH: chave privada usada para autenticação SSH.
- Senha da chave privada SSH: senha longa/senha que protege a chave privada, se houver.
- Tipo de chave privada SSH: formato da chave privada SSH.
Entidades, operações e ações
Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.
- Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para
outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.
No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista
Entities
estará vazia. - Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar
qualquer uma das seguintes operações em uma entidade:
Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista
Operations
. - Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro
de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista
Actions
estará vazia.
Limitações do sistema
O conector SFTP processa uma transação por segundo, por nó, e throttles as transações além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.
Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.
Ações
Esta seção lista algumas das ações aceitas pelo conector. Para entender como configurar as ações, consulte Exemplos de ação.
Ação de upload
A tabela a seguir descreve os parâmetros de entrada da ação Upload
.
Nome do parâmetro | Tipo de dados | Obrigatório | Descrição |
---|---|---|---|
Conteúdo | String | Não | Conteúdo a ser enviado como um arquivo. |
ContentBytes | String | Não | Conteúdo de bytes (como uma string Base64) para fazer upload como um arquivo. Use-o para fazer upload de dados binários. |
HasBytes | Booleano | Não | Especifica se o conteúdo precisa ser enviado como bytes. O valor padrão é false . |
RemoteFile | String | Sim | O nome do arquivo no host remoto. |
Substituir | Booleano | Não | Especifica se o arquivo remoto precisa ser substituído. O valor padrão é false . |
Veja como configurar a ação Upload
em Exemplos.
Ação de download
A tabela a seguir descreve os parâmetros de entrada da ação Download
.
Nome do parâmetro | Tipo de dados | Obrigatório | Descrição |
---|---|---|---|
RemoteFile | String | Sim | O nome do arquivo no host remoto. |
HasBytes | Booleano | Não | Especifica se o download do conteúdo deve ser feito em bytes. O valor padrão é false . |
Veja como configurar a ação Download
em Exemplos.
Ação MoveFile
A tabela a seguir descreve os parâmetros de entrada da ação MoveFile
.
Nome do parâmetro | Tipo de dados | Obrigatório | Descrição |
---|---|---|---|
RemoteFile | String | Sim | O caminho do arquivo remoto a ser movido. |
DestinationPath | String | Sim | O novo caminho para onde você quer mover o arquivo. |
Veja como configurar a ação MoveFile
em Exemplos.
Ação RenomearFile
A tabela a seguir descreve os parâmetros de entrada da ação RenameFile
.
Nome do parâmetro | Tipo de dados | Obrigatório | Descrição |
---|---|---|---|
RemoteFile | String | Sim | Caminho e nome do arquivo remoto que será renomeado. |
NewFileName | String | Sim | Novo nome do arquivo remoto. |
Veja como configurar a ação RenameFile
em Exemplos.
Exemplos
Nesta seção, descrevemos como executar algumas das operações e ações da entidade neste conector. Os exemplos descrevem as seguintes operações:
- Listar todos os arquivos no diretório
- Listar arquivos que correspondem a um padrão em um diretório
- Mover um arquivo
- Renomear um arquivo
- Excluir um arquivo
- Fazer upload de um arquivo de texto ASCII
- Fazer upload de um arquivo binário
- Fazer o download de um arquivo de texto ASCII
- Fazer o download de um arquivo binário
A tabela a seguir lista os cenários de exemplo e a configuração correspondente na tarefa Connectors:
Tarefa | Comando de amostra | Configuração |
---|---|---|
Listar todos os arquivos no diretório | ls / |
|
Listar arquivos .csv em um diretório |
ls /tmp/*.csv |
|
Mover um arquivo | mv /tmp/dir_A/hello_world.txt /dir_B/dir_C/ |
Neste exemplo, o arquivo [{ "Success":"true" }] |
Renomear um arquivo | mv /tmp/hello_world.txt /tmp/hello_world_new.txt |
Neste exemplo, o arquivo [{ "Success":"true" }] |
Excluir um arquivo | rm /tmp/myfile.csv |
|
Fazer upload de um arquivo de texto ASCII | put file_1.txt /tmp/file_1.txt |
Este exemplo cria o arquivo Definir o atributo |
Fazer upload de um arquivo binário | put image_1.png /tmp/image_1.png |
Para fazer upload de um conteúdo binário, primeiro é necessário codificar o conteúdo
no formato Base64. Você pode escolher a ferramenta que quiser para
codificar o conteúdo. As etapas para codificar o conteúdo estão fora do escopo deste documento. Depois de criar o conteúdo como uma string Base64, siga estas etapas:
Este exemplo cria o arquivo Definir o atributo |
Fazer o download de um arquivo de texto ASCII | get /tmp/myfile.txt |
O conteúdo do arquivo transferido por download está disponível como uma string
no campo |
Fazer o download de um arquivo binário | get /tmp/myfile.png |
O conteúdo do arquivo transferido por download está disponível como uma string codificada em Base64.
no campo |
Esquema JSON para payload
Todos os objetos de entidade em uma conexão SFTP têm um esquema JSON predefinido. Entender bem o esquema permite que você configure facilmente os valores de payload de entrada ou saída. Os objetos da entidade em uma conexão SFTP usam o seguinte 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 } } }
Configuração dinâmica do filterClause
Para as operações List, Update e Delete, é possível definir o valor da variável de entrada filterClasue
dinamicamente no momento da execução usando a tarefa
Mapeamento de dados
na sua integração. Por exemplo, é possível enviar o valor da cláusula de filtro
ao invocar o acionador de API
na sua integração. A imagem a seguir mostra um exemplo de mapeamento para
a variável filterClause
no editor de mapeamento de dados da
tarefa de mapeamento de dados:
Usar o Terraform para criar conexões
É possível usar o Terraform recurso para criar uma nova conexão.Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.
Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte Exemplo de modelo.
Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:
Nome do parâmetro | Tipo de dados | Obrigatório | Descrição |
---|---|---|---|
remote_path | STRING | Falso | O caminho atual no servidor SFTP. |
Usar a conexão SFTP em uma integração
Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. Você pode usar a conexão em uma integração pela tarefa Conectores.
- Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte a Tarefa Conectores.
- Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.
Receber ajuda da comunidade do Google Cloud
Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.A seguir
- Entenda como suspender e retomar uma conexão.
- Entenda como monitorar o uso do conector.
- Saiba como acessar os registros do conector.