Topik ini menjelaskan cara memanggil operasi API.
Sebagai pengembang, perhatikan informasi berikut saat memanggil operasi API:
Alamat pemanggilan
Apakah login diperlukan
Apakah otorisasi diperlukan
Metode pemanggilan
Hasil yang dikembalikan
Hal yang sama berlaku untuk API Alibaba Cloud.
Diagram urutan untuk memanggil operasi API Alibaba Cloud
Diagram berikut menunjukkan urutan lengkap kejadian, mulai dari pengguna mengirim permintaan API dari klien hingga menerima respons dari layanan Alibaba Cloud.
Pengguna mengirim permintaan HTTP untuk memanggil operasi yang disediakan oleh server bisnis. Sebagai contoh, permintaan digunakan untuk menanyakan status instance Elastic Compute Service (ECS).
Server bisnis menerima permintaan dari klien bisnis dan memverifikasi validitas parameter. Server menyesuaikan parameter sesuai dengan dokumentasi API serta menandatangani permintaan. Jika SDK Alibaba Cloud digunakan untuk memanggil operasi API, server bisnis tidak perlu melakukan penandatanganan, karena SDK sudah mencakup logika tersebut.
Server bisnis menginisiasi permintaan untuk mengakses titik akhir gateway API.
Gateway API menerima permintaan dari server bisnis, memverifikasi tanda tangan, mengurai identitas pemanggil, dan melakukan autentikasi.
Setelah autentikasi berhasil, permintaan diteruskan ke alamat layanan internal.
Produk cloud menerima permintaan dari gateway, melakukan operasi pada sumber daya cloud yang ditentukan, dan mengembalikan hasil eksekusi.
Gateway API menerima data yang dikembalikan dari produk cloud, mengonversinya ke format keluaran standar, dan mengembalikan data ke server bisnis.
Server bisnis menerima data dari gateway API, memproses hasilnya, dan mengembalikannya ke klien bisnis.
Istilah
Titik Akhir
Titik akhir adalah alamat layanan yang terdaftar di gateway untuk mengakses produk cloud. Titik akhir merupakan URL yang menentukan protokol akses, nama host, port, dan jalur layanan. Pengguna dapat menggunakan informasi ini untuk berkomunikasi dengan layanan cloud.
Identitas, kredensial, dan autentikasi
API Alibaba Cloud diklasifikasikan menjadi dua jenis: API anonim dan API terotentikasi. Untuk memanggil API anonim, pastikan permintaan sesuai dengan gaya API. Tidak diperlukan autentikasi.
Untuk memanggil API terotentikasi, gateway memverifikasi kredensial permintaan untuk mengonfirmasi identitas pemanggil. Permintaan hanya diteruskan ke layanan cloud setelah identitas lolos pemeriksaan izin.
Metode pemanggilan
Alibaba Cloud menyediakan beberapa metode untuk memanggil operasi API, termasuk SDK Alibaba Cloud, CLI Alibaba Cloud, dan Resource Orchestration Service (ROS). Anda juga dapat mengimplementasikan permintaan HTTP secara mandiri.
Kami merekomendasikan menggunakan SDK Alibaba Cloud untuk memanggil operasi API.