SFTP
Konektor SFTP memungkinkan Anda terhubung ke server SFTP dan melakukan operasi transfer file.
Sebelum memulai
Sebelum menggunakan konektor SFTP, lakukan tugas berikut:
- Di project Google Cloud Anda:
- Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
- Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
- Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk informasi selengkapnya, lihat Membuat akun layanan.
- Aktifkan layanan berikut:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.
Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.
Mengonfigurasi konektor
Untuk mengonfigurasi konektor, Anda harus membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:
- Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.
- Klik + Buat baru untuk membuka halaman Buat Koneksi.
- Di bagian Location, pilih lokasi untuk koneksi.
- Region: Pilih lokasi dari menu drop-down.
Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.
- Klik Berikutnya.
- Region: Pilih lokasi dari menu drop-down.
- Di bagian Connection Details, selesaikan tindakan berikut:
- Connector: Pilih SFTP dari menu drop-down Konektor yang tersedia.
- Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
- Di kolom Connection Name, masukkan nama untuk instance Connection.
Nama koneksi harus memenuhi kriteria berikut:
- Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
- Huruf harus berupa huruf kecil.
- Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
- Nama koneksi tidak boleh melebihi 49 karakter.
- Secara opsional, masukkan Description untuk instance koneksi.
- Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke
Error
. - Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
- Secara opsional, konfigurasikan Setelan node koneksi:
- Jumlah node minimum: Masukkan jumlah minimum node koneksi.
- Maximum number of nodes: Masukkan jumlah maksimum node koneksi.
Node adalah unit (atau replika) koneksi yang memproses transaksi. Semakin banyak node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi, dan sebaliknya, semakin sedikit node yang diperlukan untuk memproses lebih sedikit transaksi. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default, node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.
-
Jalur Jarak Jauh: Jalur folder di server SFTP.
Pertimbangkan untuk menetapkan kolom ini hanya jika Anda ingin melakukan operasi entity seperti
List
,Create
,Update
, atauDelete
.Jika Anda mengakses entitas (file atau folder) di folder root, atau folder turunan langsung dari folder root, Anda tidak perlu menetapkan nilai apa pun ke kolom ini. Namun, jika Anda ingin mengakses entitas bertingkat yang berada pada kedalaman 2 tingkat atau lebih dari folder root, Anda harus menetapkan nilai kolom ini ke jalur dasar folder yang memiliki entitas yang ingin diakses. Misalnya, jika ingin mengakses file
/folder_A/folder_B/folder_C/test.png
, Anda harus menetapkan Jalur Jarak Jauh ke/folder_A/folder_B/folder_C
. - Secara opsional, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan nilai kunci.
- Klik Berikutnya.
- Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
- Jenis Tujuan: Pilih Jenis Tujuan.
- Pilih Host address dari daftar untuk menentukan nama host atau alamat IP tujuan.
- Jika Anda ingin membuat koneksi pribadi ke sistem backend, pilih Endpoint attachment dari daftar, lalu pilih lampiran endpoint yang diperlukan dari daftar Endpoint Attachment.
Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.
Untuk memasukkan tujuan tambahan, klik +Tambahkan tujuan.
- Klik Berikutnya.
- Jenis Tujuan: Pilih Jenis Tujuan.
-
Di bagian Authentication, masukkan detail autentikasi.
- Pilih Jenis autentikasi dan masukkan detail yang relevan.
Jenis autentikasi berikut didukung oleh koneksi SFTP:
- Nama pengguna dan sandi
- SSH_PUBLIC_KEY
- Klik Berikutnya.
Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.
- Pilih Jenis autentikasi dan masukkan detail yang relevan.
- Tinjau: Tinjau detail koneksi dan autentikasi Anda.
- Klik Create.
Mengonfigurasi autentikasi
Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.
-
Nama pengguna dan sandi
- Nama pengguna: Nama pengguna SFTP yang akan digunakan untuk koneksi.
- Sandi: Secret Secret Manager yang berisi sandi yang terkait dengan nama pengguna SFTP.
-
SSH_PUBLIC_KEY
- Nama pengguna: Akun pengguna SFTP yang digunakan untuk mengautentikasi.
- Kunci Pribadi SSH: Kunci Pribadi untuk autentikasi SSH.
- Sandi Kunci Pribadi SSH: Frasa sandi/sandi yang melindungi kunci pribadi, jika ada.
- Jenis Kunci Pribadi SSH: Format Kunci Pribadi.
Entity, operasi, dan tindakan
Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.
- Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam
aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, dalam konektor database, tabel adalah entitas, dalam
konektor server file, folder adalah entitas, dan dalam konektor sistem pesan,
antrean adalah entitas.
Namun, mungkin konektor tidak mendukung atau memiliki entity apa pun, dalam hal ini, daftar
Entities
akan kosong. - Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan
salah satu operasi berikut pada entitas:
Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar
Operations
. - Tindakan: Tindakan adalah fungsi kelas satu yang tersedia untuk integrasi
melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan
bervariasi dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter
output. Namun, konektor mungkin
tidak mendukung tindakan apa pun, dalam hal ini daftar
Actions
akan kosong.
Batasan sistem
Konektor SFTP dapat memproses 1 transaksi per detik, per node, dan memperlambat transaksi apa pun di luar batas ini. Secara default, Konektor Integrasi mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.
Untuk mengetahui informasi tentang batas yang berlaku untuk Konektor Integrasi, lihat Batas.
Tindakan
Bagian ini mencantumkan beberapa tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.
Tindakan upload
Tabel berikut menjelaskan parameter input tindakan Upload
.
Nama parameter | Jenis data | Wajib | Deskripsi |
---|---|---|---|
Konten | String | Tidak | Konten yang akan diupload sebagai file. |
ContentBytes | String | Tidak | Konten byte (sebagai string Base64) untuk diupload sebagai file. Gunakan ini untuk mengupload data biner. |
HasBytes | Boolean | Tidak | Menentukan apakah konten harus diupload sebagai byte. Nilai defaultnya adalah false . |
RemoteFile | String | Ya | Nama file di host jarak jauh. |
Timpa | Boolean | Tidak | Menentukan apakah file jarak jauh harus ditimpa. Nilai defaultnya adalah false . |
Untuk contoh cara mengonfigurasi tindakan Upload
, lihat Contoh.
Tindakan download
Tabel berikut menjelaskan parameter input tindakan Download
.
Nama parameter | Jenis data | Wajib | Deskripsi |
---|---|---|---|
RemoteFile | String | Ya | Nama file di host jarak jauh. |
HasBytes | Boolean | Tidak | Menentukan apakah konten harus didownload sebagai byte. Nilai defaultnya adalah false . |
Untuk contoh cara mengonfigurasi tindakan Download
, lihat Contoh.
Tindakan MoveFile
Tabel berikut menjelaskan parameter input tindakan MoveFile
.
Nama parameter | Jenis data | Wajib | Deskripsi |
---|---|---|---|
RemoteFile | String | Ya | Jalur file jarak jauh yang akan dipindahkan. |
DestinationPath | String | Ya | Jalur baru tempat Anda ingin memindahkan file. |
Untuk contoh cara mengonfigurasi tindakan MoveFile
, lihat Contoh.
Tindakan RenameFile
Tabel berikut menjelaskan parameter input tindakan RenameFile
.
Nama parameter | Jenis data | Wajib | Deskripsi |
---|---|---|---|
RemoteFile | String | Ya | Jalur dan nama file jarak jauh yang akan diganti namanya. |
NewFileName | String | Ya | Nama baru file jarak jauh. |
Untuk contoh cara mengonfigurasi tindakan RenameFile
, lihat Contoh.
Contoh
Bagian ini menjelaskan cara melakukan beberapa operasi dan tindakan entitas di konektor ini. Contoh ini menjelaskan operasi berikut:
- Mencantumkan semua file di direktori root
- Mencantumkan file yang cocok dengan pola di direktori
- Memindahkan file
- Mengganti nama file
- Menghapus file
- Mengupload file teks ASCII
- Mengupload file biner
- Mendownload file teks ASCII
- Mendownload file biner
Tabel berikut mencantumkan contoh skenario dan konfigurasi yang sesuai dalam tugas Konektor:
Tugas | Contoh perintah | Konfigurasi |
---|---|---|
Mencantumkan semua file di direktori root | ls / |
|
Mencantumkan file .csv dalam direktori |
ls /tmp/*.csv |
|
Memindahkan file | mv /tmp/dir_A/hello_world.txt /dir_B/dir_C/ |
Contoh ini memindahkan file [{ "Success":"true" }] |
Mengganti nama file | mv /tmp/hello_world.txt /tmp/hello_world_new.txt |
Contoh ini mengganti nama file [{ "Success":"true" }] |
Menghapus file | rm /tmp/myfile.csv |
|
Mengupload file teks ASCII | put file_1.txt /tmp/file_1.txt |
Contoh ini membuat file Menetapkan atribut |
Mengupload file biner | put image_1.png /tmp/image_1.png |
Untuk mengupload konten biner, Anda harus mengenkode konten terlebih dahulu dalam format Base64. Anda dapat memilih alat pilihan untuk
enkode konten. Langkah-langkah untuk mengenkode konten berada di luar
cakupan dokumen ini. Setelah Anda memiliki konten sebagai
string Base64, lakukan langkah-langkah berikut:
Contoh ini membuat file Menetapkan atribut |
Mendownload file teks ASCII | get /tmp/myfile.txt |
Konten file yang didownload tersedia sebagai string
di kolom |
Mendownload file biner | get /tmp/myfile.png |
Konten file yang didownload tersedia sebagai string berenkode Base64
di kolom |
Skema JSON untuk payload
Semua objek entitas dalam koneksi SFTP memiliki skema JSON yang telah ditentukan sebelumnya. Dengan pemahaman yang baik tentang skema, Anda dapat dengan mudah mengonfigurasi nilai payload input atau output. Objek entity dalam koneksi SFTP menggunakan skema JSON berikut:
{ "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 } } }
Konfigurasi dinamis filterClause
Untuk operasi List, Update, dan Delete, Anda dapat menetapkan nilai variabel input filterClasue secara dinamis saat runtime menggunakan tugas Pemetaan Data dalam integrasi Anda. Misalnya, Anda mungkin ingin mengirim nilai klausa filter saat memanggil pemicu API dalam integrasi. Gambar berikut menunjukkan contoh pemetaan untuk variabel filterClause
di editor Pemetaan Data pada tugas Pemetaan Data:
Menggunakan terraform untuk membuat koneksi
Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.
Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.
Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:
Nama parameter | Jenis data | Wajib | Deskripsi |
---|---|---|---|
remote_path | STRING | Salah | Jalur saat ini di server SFTP. |
Menggunakan koneksi SFTP dalam integrasi
Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.
- Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
- Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.
Mendapatkan bantuan dari komunitas Google Cloud
Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.Langkah selanjutnya
- Pahami cara menangguhkan dan melanjutkan koneksi.
- Pahami cara memantau penggunaan konektor.
- Pahami cara melihat log konektor.