HTTP
Konektor HTTP menyediakan konektivitas ke layanan HTTP dan menggunakan API berbasis HTTP. Konektor juga mendukung konektivitas SSL/TLS melalui konfigurasi kustom dan mendukung berbagai mekanisme autentikasi seperti Pemberian Kredensial Klien OAuth 2.0, Dasar, dan Digest.
Sebelum memulai
Sebelum menggunakan konektor HTTP, lakukan tugas berikut:
- Di project Google Cloud Anda:
- 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 melakukan autentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk mengetahui 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
Mengonfigurasi konektor mengharuskan Anda 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 Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.
- Klik + Create New untuk membuka halaman Create Connection.
- Di bagian Lokasi, pilih lokasi untuk koneksi.
- Region: Pilih lokasi dari menu drop-down.
Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.
- Klik Next.
- Region: Pilih lokasi dari menu drop-down.
- Di bagian Connection Details, selesaikan tindakan berikut:
- Konektor: Pilih HTTP 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 kecil.
- Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
- Nama koneksi tidak boleh lebih dari 63 karakter.
- Secara opsional, masukkan Deskripsi untuk instance koneksi.
- Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
- Secara opsional, konfigurasikan Setelan node koneksi:
- Jumlah minimum node: Masukkan jumlah minimum node koneksi.
- Jumlah maksimum node: Masukkan jumlah maksimum node koneksi.
{i>Node<i} adalah unit (atau replika) koneksi yang memproses transaksi. Lebih banyak node diperlukan untuk memproses lebih banyak transaksi untuk sebuah koneksi dan sebaliknya, lebih sedikit node diperlukan untuk memproses transaksi yang lebih sedikit. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum akan ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.
-
Use proxy: Pilih kotak centang guna mengonfigurasi server proxy untuk koneksi.
- Klik + Tambahkan tujuan.
- Pilih Jenis Tujuan.
- Alamat host: Tentukan nama host atau alamat IP tujuan.
Jika ingin membuat koneksi pribadi ke backend Anda, lakukan hal berikut:
- Buat lampiran layanan PSC.
- Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
- Alamat host: Tentukan nama host atau alamat IP tujuan.
- Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
- Secara opsional, jika Anda ingin menggunakan SSL, pilih Aktifkan SSL. Tindakan ini akan menampilkan detail konfigurasi SSL.
- Pilih jenis penyimpanan trust. Koneksi tersebut dapat berupa Publik, Pribadi, atau Koneksi Tidak Aman.
- Pilih sertifikat yang ditampilkan berdasarkan pilihan trust store Anda.
- Jika Anda menggunakan mTLS, pilih sertifikat key store di bagian Key Store.
- Secara opsional, pilih versi TLS.
- Masukkan cipher suite yang didukung. Masukkan beberapa cipher suite, sebagai nilai yang dipisahkan koma. Untuk mengetahui informasi selengkapnya, lihat Cipher suite yang didukung.
- Klik Next.
- Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
- Jenis Tujuan: Pilih Jenis Tujuan.
- Di kolom Host address, tentukan nama host atau alamat IP tujuan.
- Jika ingin membuat koneksi pribadi ke sistem backend, ikuti langkah-langkah berikut:
- Buat lampiran layanan PSC.
- Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
- Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi Anda, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.
- Jika ingin membuat koneksi pribadi ke sistem backend, ikuti langkah-langkah berikut:
Untuk memasukkan tujuan tambahan, klik + Tambahkan tujuan.
- Di kolom Host address, tentukan nama host atau alamat IP tujuan.
- Klik Next.
- Jenis Tujuan: Pilih Jenis Tujuan.
-
Di bagian Authentication, masukkan detail autentikasi.
- Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
Jenis autentikasi berikut didukung oleh koneksi HTTP:
- Autentikasi Kustom
- OAuth 2.0 - Pemberian kredensial klien
- Autentikasi Dasar
- Autentikasi Intisari
- OAuth 2.0 - Kode otorisasi
- Service account
- Autentikasi token ID akun layanan
- Autentikasi kunci API
- Klik Next.
Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.
- Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
- Tinjau: Tinjau detail koneksi dan autentikasi Anda.
- Klik Create.
Mengonfigurasi autentikasi
Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.
- Autentikasi Kustom
Detail otorisasi kustom dapat ditambahkan sebagai header permintaan selama eksekusi tindakan tugas Connectors.
- OAuth 2.0 - Pemberian kredensial klien
- Client-ID: Client ID yang akan digunakan untuk mengautentikasi permintaan HTTP.
- Rahasia Klien: Secret Manager yang berisi rahasia klien untuk mengautentikasi permintaan HTTP.
- Format permintaan untuk token akses: Format permintaan yang akan digunakan dalam permintaan yang dibuat untuk mengambil token akses dari server autentikasi.
Pilih
body
untuk meneruskan client ID dan Secret sebagai isi permintaan, atauheader
untuk meneruskannya sebagai header yang dienkode. - Jalur Permintaan Token: Jalur permintaan untuk ditambahkan ke URL server autentikasi guna mengambil URL token akses.
- Waktu Habis Masa Berlaku Default: Waktu habis masa berlaku default (dalam detik) untuk token akses. Waktu ini akan digunakan jika respons token akses tidak memiliki waktu habis masa berlaku. Jika nilai tidak diberikan, token akan diperbarui setelah 6 jam.
- Autentikasi Dasar
- Nama pengguna: Nama pengguna yang digunakan untuk membuat permintaan HTTP.
- Password: Secret Manager berisi sandi yang terkait dengan nama pengguna yang diberikan.
- Autentikasi Intisari
- Nama pengguna: Nama pengguna yang digunakan untuk membuat permintaan HTTP.
- Password: Secret Manager berisi sandi yang terkait dengan nama pengguna yang diberikan.
- OAuth 2.0 - Kode otorisasi
- Client-ID: Client ID yang diberikan oleh aplikasi eksternal Anda.
- Cakupan: Cakupan izin yang didukung oleh aplikasi eksternal Anda.
- Rahasia klien: Pilih Secret Manager. Anda seharusnya sudah membuat rahasia Secret Manager sebelum mengonfigurasi otorisasi ini.
- Versi secret: Versi rahasia Secret Manager untuk rahasia klien.
- Secara opsional, aktifkan PKCE (Kunci Bukti untuk Code Exchange) jika server backend Anda mendukungnya.
- URL Otorisasi: Masukkan URL otorisasi untuk aplikasi eksternal Anda.
- URL token akses: Masukkan URL untuk mendapatkan token akses aplikasi eksternal Anda.
- Service account
Pilih opsi ini untuk mengautentikasi menggunakan akun layanan yang Anda berikan dalam langkah-langkah sebelumnya saat mengonfigurasi koneksi ini. Pastikan Anda telah memberikan peran IAM yang relevan dan izin yang diperlukan untuk autentikasi ke akun layanan tersebut.
- Cakupan: Masukkan cakupan akses yang dipisahkan koma yang Anda perlukan. Untuk informasi selengkapnya, lihat Cakupan akses.
- Autentikasi token ID akun layanan
Pilih opsi ini untuk melakukan autentikasi menggunakan token ID yang dibuat dari akun layanan yang Anda berikan di langkah sebelumnya. Autentikasi ini menggunakan JSON Web Token (JWT) untuk autentikasi. Penyedia token ID, menandatangani dan menerbitkan JWT untuk autentikasi menggunakan akun layanan.
- Audiens: Masukkan penerima yang akan menerima JWT.
- Header Name: Masukkan nama header untuk token ID yang dibuat yang akan digunakan di header HTTP. Jika Anda tidak
menentukan nilai apa pun untuk kolom ini, nilai kunci secara default ditetapkan ke
Authorization
.
- Autentikasi kunci API
Pilih opsi ini untuk mengautentikasi menggunakan kunci API.
- API key: Pilih secret Secret Manager untuk kunci API.
- Secret version: Pilih versi secret.
- Nama parameter kunci API: Masukkan nama parameter untuk kunci API. Kunci API dikirim ke server backend sebagai pasangan nilai kunci. Nilai yang Anda masukkan di sini akan digunakan sebagai nama kunci untuk kunci API yang telah Anda pilih sebelumnya.
- API key location: Pilih tempat Anda ingin menambahkan kunci API dalam permintaan.
Untuk jenis autentikasi Authorization code
, setelah membuat koneksi, Anda harus melakukan beberapa langkah tambahan untuk mengonfigurasi autentikasi. Untuk mengetahui informasi selengkapnya,
lihat Langkah tambahan setelah pembuatan koneksi.
Cipher suite yang didukung
Versi TLS | Cipher suite yang didukung |
---|---|
1,2 |
|
1,3 |
|
Langkah-langkah tambahan setelah pembuatan koneksi
Jika memilih OAuth 2.0 - Authorization code
untuk autentikasi, Anda harus melakukan langkah-langkah tambahan berikut setelah membuat koneksi:
- Di halaman Koneksi, temukan koneksi yang baru dibuat.
Perhatikan bahwa Status untuk konektor baru adalah Diperlukan otorisasi.
- Klik Diperlukan otorisasi.
Ini akan menampilkan panel Edit authorization.
- Salin nilai Redirect URI ke aplikasi eksternal Anda.
- Verifikasi detail otorisasi.
- Klik Authorize.
Jika otorisasi berhasil, status koneksi akan disetel ke Active di halaman Koneksi.
Otorisasi ulang untuk kode Otorisasi
Jika menggunakan jenis autentikasi Authorization code
dan telah membuat perubahan konfigurasi di aplikasi HTTP backend, Anda harus memberikan otorisasi ulang koneksi HTTP. Untuk mengizinkan ulang koneksi, lakukan langkah-langkah berikut:
- Klik koneksi yang diperlukan di halaman Koneksi.
Tindakan ini akan membuka halaman detail koneksi.
- Klik Edit untuk mengedit detail koneksi.
- Verifikasi detail OAuth 2.0 - Authorization code di bagian Authentication.
Jika diperlukan, buat perubahan yang diperlukan.
- Klik Save. Tindakan ini akan mengarahkan Anda ke halaman detail koneksi.
- Klik Edit authorization di bagian Authentication. Tindakan ini akan menampilkan panel Authorize.
- Klik Authorize.
Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.
Entitas, operasi, dan tindakan
Semua Integration Connectors menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entity, operasi, dan tindakan.
- Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam
aplikasi atau layanan yang terhubung. Definisi entity berbeda dari konektor ke konektor. Misalnya, pada konektor database, tabel adalah entity, pada konektor server file, folder adalah entity, dan di konektor sistem pesan, antrean adalah entity.
Namun, mungkin saja konektor tidak mendukung atau memiliki entitas, 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 entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk deskripsi operasi secara mendetail, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung salah satu operasi entity, operasi yang tidak didukung tersebut tidak akan dicantumkan dalam daftar
Operations
. - Tindakan: Tindakan adalah fungsi kelas pertama 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. Namun, mungkin saja konektor tidak mendukung tindakan apa pun, dalam hal ini daftar
Actions
akan kosong.
Keterbatasan sistem
Konektor HTTP dapat memproses 100 transaksi per detik, per node, dan men-throttle setiap transaksi di luar batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk satu koneksi.
Untuk informasi tentang batas yang berlaku untuk Konektor Integrasi, lihat Batas.
Tindakan yang didukung
Konektor HTTP mendukung tindakan berikut:
Tindakan HttpRequest
Tabel berikut menjelaskan parameter input dan output tindakan HttpRequest.
Parameter input tindakan HttpRequest
Nama parameter | Jenis data | Diperlukan | Deskripsi |
---|---|---|---|
URL | Struct | Tidak | URL yang akan dikirimi permintaan.
URL tersebut memiliki format <scheme>://<netloc>/<path>;<params>?<query>#<fragment> .
Jika Anda memberikan netloc , nama host akan diganti dengan nama host yang diberikan selama pembuatan koneksi. |
Metode | String | Tidak | Metode permintaan HTTP seperti GET, POST, DELETE, atau PUT. Nilai defaultnya adalah GET. |
Header | Struct | Tidak | Header permintaan HTTP. |
Isi | String | Tidak | Isi permintaan HTTP. |
RequestHasBytes | Boolean | Tidak | Apakah akan mengirim permintaan sebagai byte. Jika ditetapkan ke true , Anda harus mengirim permintaan sebagai string berenkode Base64 dalam parameter Body . Nilai defaultnya adalah false . |
ResponseHasBytes | Boolean | Tidak | Apakah akan menerima respons sebagai byte. Jika ditetapkan ke true , Anda akan menerima respons sebagai string berenkode Base64 dalam parameter output ResponseBody . Nilai defaultnya adalah false . |
HttpVersion | String | Tidak | Versi HTTP yang akan digunakan saat membuat permintaan. Nilai yang didukung adalah 1.1 dan 2. Jika Anda menentukan versi 2, negosiasi ALPN (Application-Layer Protocol Negotiation) akan berlangsung dan versi 1.1 akan digunakan jika server tidak mendukung versi 2. Nilai defaultnya adalah 2. |
ResponseFormat | String | Tidak | Menentukan format respons dari konektor. Nilai yang didukung adalah v1 dan v2 .
Nilai defaultnya adalah v1 .
Contoh respons v1: [{ "ResponseBody": "{\n \"status\": 200\n}" }, { "StatusCode": 200.0 }, { "HttpVersion": "2" }, { "ResponseHeaders": { ":status": "200", "content-length": "19" } }] Contoh respons v2: [{ "ResponseBody": "{\n \"status\": 200\n}", "StatusCode": 200.0, "HttpVersion": "2", "ResponseHeaders": { ":status": "200", "content-length": "19" } }] |
FailOnError | Boolean | Tidak | Menentukan perilaku koneksi jika terjadi error dalam aplikasi backend Anda.
Nilai defaultnya adalah |
Parameter output tindakan HttpRequest
Nama parameter | Jenis data | Deskripsi |
---|---|---|
ResponseBody | String | Respons diterima dari server HTTP. |
StatusCode | Bilangan bulat | Kode status yang diterima dari Server HTTP. |
HttpVersion | String | Versi yang dinegosiasikan untuk Permintaan HTTP. |
ResponseHeaders | Struct | Header respons HTTP dalam bentuk pasangan key,value . |
Contoh
Contoh di bagian ini menjelaskan operasi berikut:
- Mengonfigurasi payload permintaan
- Mengirim konten byte
- Mendapatkan konten byte
Tabel berikut mencantumkan contoh skenario dan konfigurasi yang sesuai dalam tugas Konektor:
Tugas | Konfigurasi |
---|---|
Mengonfigurasi payload permintaan |
Contoh ini membuat permintaan POST ke URL |
Mengirim konten byte |
Untuk mengirim konten byte (seperti file), Anda harus menetapkan atribut permintaan
Contoh ini membuat permintaan POST ke server |
Mendapatkan konten byte |
Untuk mendapatkan byte (sebagai string Base64) dari server, Anda harus menetapkan atribut permintaan
Contoh ini membuat permintaan GET ke server |
Kode error
Bagian ini menguraikan pesan error yang mungkin Anda dapatkan saat menggunakan koneksi HTTP.
Pesan error | Penyebab |
---|---|
Kesalahan menyambungkan dengan server HTTP | Koneksi HTTP gagal terhubung dengan server karena kegagalan handshake SSL atau endpoint server HTTP yang salah. |
Respons error yang diterima dari server HTTP | Server HTTP yang Anda coba hubungkan mengembalikan respons kesalahan dengan kode status 4xx atau 5xx. Contoh respons:
{ "error": { "code": 400, "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "metadata": { "Body": "{\"thisIsResponseJSON\":\"someValue\"}" "Error": "Error response received from the HTTP server", "Headers": "{\":status\":[\"400\"], \"access-control-allow-credentials\":[\"true\"]}", "StatusCode": "400", "connection_type": "Http" } } ], "message": "Unable to execute HTTP Request", "status": "FAILED_PRECONDITION" } } |
Terjadi error saat mengambil token akses | Terjadi error saat mengambil token akses untuk jenis autentikasi OAuth Client Credentials Grant . |
Error Autentikasi Intisari | Runtime konektor belum menerima tantangan ringkasan atau tantangan memiliki jenis yang tidak didukung. |
Gunakan 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 | Diperlukan | Deskripsi |
---|---|---|---|
proxy_enabled | BOOLEAN | Salah | Pilih kotak centang ini untuk mengonfigurasi server proxy untuk koneksi. |
Menggunakan koneksi HTTP dalam integrasi
Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.
- Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Apigee, lihat Tugas konektor.
- Untuk memahami cara membuat dan menggunakan tugas Konektor dalam Application Integration, lihat tugas konektor.
Dapatkan bantuan dari komunitas Google Cloud
Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.Langkah selanjutnya
- Memahami cara menangguhkan dan melanjutkan koneksi.
- Pahami cara memantau penggunaan konektor.
- Pahami cara melihat log konektor.