Grup API digunakan untuk mengelola API dan dapat berupa nama sistem tertentu, nama modul, atau pengenal abstrak.
Saat ini, Mobile Gateway mendukung jenis grup API berikut:
HTTP: Grup untuk layanan HTTP RESTful yang mendukung pemanggilan layanan lintas virtual private cloud (VPC).
MPC: Grup untuk layanan berbasis framework RPC proprietary mPaaS yang mendukung pemanggilan layanan lintas-VPC.
Buat grup
Sebelum membuat grup API MPC, Anda harus mendaftarkan layanan API ke registri yang ditentukan. Untuk informasi selengkapnya, lihat Daftarkan layanan API MPC.
Login ke Konsol mPaaS dan navigasikan ke halaman Mobile Gateway melalui panel navigasi di sebelah kiri. Anda kemudian dapat membuat berbagai jenis grup API sesuai kebutuhan.
Buat grup API HTTP
Untuk membuat grup API HTTP, lakukan langkah-langkah berikut:
Klik tab API Group untuk membuka halaman daftar grup API.
Klik Create API Group. Pada kotak dialog yang muncul, konfigurasikan parameter berikut.
Group Type: Pilih HTTP.
API Group: Wajib diisi. Masukkan nama dalam bahasa Inggris dari layanan backend.
Cross-VPC HTTP: Menentukan apakah pemanggilan layanan lintas-VPC diizinkan. Jika diaktifkan, Anda dapat memanggil layanan di VPC yang berbeda. Fitur ini dirancang untuk skenario di mana Mobile Gateway Service (MGS) dan layanan Anda diterapkan di VPC yang berbeda, dan Anda perlu menggunakan MGS untuk memanggil layanan backend lintas VPC tersebut.
CatatanFitur Cross-VPC HTTP hanya tersedia di wilayah Shanghai Finance.
Untuk mengaktifkan fitur pemanggilan Cross-VPC HTTP, konfigurasikan parameter berikut:
Support HTTPS: MGS dapat meneruskan Permintaan HTTPS menggunakan Pendengar HTTPS Server Load Balancer (SLB). Ini menyediakan enkripsi dalam transit. Secara default, fitur ini diaktifkan. Jika Anda tidak perlu menggunakan nama domain HTTPS, pilih No.
HTTPS Domain Name: Parameter ini wajib diisi hanya jika Anda mengaktifkan dukungan HTTPS. Nilainya harus berupa nama domain dari Sertifikat yang telah disambungkan ke instance SLB.
VPC ID: ID VPC tempat instance Elastic Compute Service (ECS) untuk penerapan layanan berada, atau VPC tempat instance SLB berada.
Instance IP or Address: Alamat IP pribadi utama dari instance ECS untuk penerapan layanan, atau alamat IP dari instance SLB.
Port Number: Nomor port layanan.
PentingMGS tidak mendukung sertifikat tanda tangan sendiri. Saat menggunakan Cross-VPC HTTPS, Anda harus menggunakan nama domain dengan sertifikat yang ditandatangani oleh CA. Jika tidak, resolusi nama domain akan gagal.
Jika Anda hanya menggunakan instance ECS untuk mengonfigurasi layanan backend, buka port yang diperlukan di security group instance ECS tersebut agar permintaan tidak diblokir oleh kebijakan keamanan. Untuk mendapatkan informasi port dan alamat IP yang diperlukan, kirim tiket untuk menghubungi helpdesk.
Akses lintas-VPC hanya didukung dalam wilayah yang sama. Misalnya, layanan yang diterapkan di wilayah Hangzhou tidak dapat memanggil layanan di wilayah Shanghai. Selain itu, zona finance dan non-finance dalam satu kota yang sama dianggap sebagai wilayah yang berbeda. Contohnya, wilayah Hangzhou Finance dan wilayah Hangzhou non-finance merupakan dua wilayah yang berbeda.
Jika Anda menggunakan instance SLB dan ECS secara bersamaan untuk mengonfigurasi layanan backend, pastikan instance SLB dan ECS berada dalam VPC yang sama.
Service Endpoint: URL HTTP atau HTTPS dari layanan backend. Parameter ini wajib diisi jika fitur Cross-VPC HTTP dinonaktifkan.
Timeout: Opsional. Batas waktu untuk permintaan yang dikirim ke layanan backend. Satuan: milidetik. Nilai default adalah 3000 ms.
Setelah mengonfigurasi parameter, klik OK untuk membuat grup.
Buat grup API MPC
Untuk membuat grup API MPC, lakukan langkah-langkah berikut:
Klik tab API Group untuk membuka halaman daftar grup API.
Klik Create API Group. Pada kotak dialog yang muncul, konfigurasikan parameter berikut.
Group Type: Pilih MPC.
API Group: Wajib diisi. Masukkan nama dalam bahasa Inggris dari layanan backend. Nama grup API harus sama dengan nama aplikasi dari layanan API yang telah didaftarkan.
Timeout: Opsional. Batas waktu untuk permintaan yang dikirim ke layanan backend. Satuan: milidetik. Nilai default adalah 3000 ms.
Project Name: Nama proyek dari lingkungan saat ini digunakan secara default.
Setelah mengonfigurasi parameter, klik OK untuk membuat grup.
Konfigurasi grup
Konfigurasikan grup API berdasarkan jenisnya.
Konfigurasikan grup API HTTP
Pada daftar grup API, temukan grup API HTTP yang ingin Anda konfigurasi. Di kolom Operations, klik Details untuk membuka halaman detail. Di pojok kanan atas halaman detail, klik Modify. Anda dapat mengonfigurasi parameter berikut untuk grup API HTTP:
Service Endpoint: URL layanan HTTP backend.
Timeout: Satuan: milidetik. Nilai default adalah 3000 ms.
Verify Signature: Aktifkan opsi ini jika layanan backend perlu melakukan otentikasi terhadap identitas pemanggil. Untuk informasi selengkapnya tentang otentikasi, lihat Verifikasi signature backend. Setelah mengaktifkan verifikasi signature, konfigurasikan parameter berikut:
Signature Algorithm: Algoritma yang digunakan untuk menghasilkan signature. mPaaS Mobile Gateway di public cloud mendukung algoritma MD5, RSA, SM2, dan SM3.
Key: Kunci yang digunakan untuk verifikasi signature backend. Anda dapat menyesuaikan kunci ini.
Key Content: Nilai kunci yang digunakan untuk verifikasi signature backend.
Jika algoritma signature adalah MD5, Anda dapat menyesuaikan konten kunci.
Jika algoritma signature adalah RSA, nilainya adalah kunci publik dari Mobile Gateway.
Jika algoritma signature adalah SM2 atau SM3, Anda dapat menyesuaikan konten kunci. Untuk informasi selengkapnya tentang cara menghasilkan kunci, lihat Metode pembuatan kunci.
Konfigurasikan grup MPC
Pada daftar grup API, temukan grup API MPC yang ingin Anda konfigurasi. Di kolom Operations, klik Details untuk membuka halaman detail. Di pojok kanan atas halaman detail, klik Modify. Anda dapat mengonfigurasi parameter berikut untuk grup API MPC:
Project Name: Nama proyek dari penyewa tempat grup tersebut berada. Nilai ini diambil secara otomatis dan tidak dapat diubah.
Timeout: Satuan: milidetik. Nilai default adalah 3000 ms.