API Alibaba Cloud adalah serangkaian alat yang memungkinkan pengembang mengelola dan memanggil berbagai layanan Alibaba Cloud melalui antarmuka pemrograman. Sebagai contoh, Anda dapat memanggil operasi API dari Elastic Compute Service (ECS), Object Storage Service (OSS), dan Short Message Service (SMS). Topik ini menjelaskan cara melakukan debug operasi API secara online.
Buat akun Alibaba Cloud
Anda harus menggunakan akun Alibaba Cloud untuk memanggil operasi API. Jika Anda belum memiliki akun Alibaba Cloud, kunjungi atau Situs Resmi Alibaba Cloud untuk membuat akun.
Aktifkan layanan Alibaba Cloud
Gunakan salah satu metode berikut untuk mengaktifkan layanan Alibaba Cloud yang diperlukan. Dalam contoh ini, SMS diaktifkan.
Masuk ke konsol Pusat Pengguna. Cari SMS, pilih SMS, lalu klik Aktifkan untuk mengaktifkan layanan tersebut.
Kunjungi halaman pembelian halaman pembelian SMS dan aktifkan layanan tersebut.
Operasi API layanan Alibaba Cloud hanya dapat dipanggil setelah layanan terkait diaktifkan.
Debug operasi API secara online
Masuk ke OpenAPI Explorer. Di bilah navigasi atas, arahkan pointer ke Produk Cloud dan pilih layanan Alibaba Cloud yang telah diaktifkan yang ingin Anda kelola. Dalam contoh ini, ECS dipilih. Di pojok kanan atas halaman layanan, klik Debug.
Di halaman debugging, pilih operasi API yang ingin Anda debug. Dalam contoh ini, operasi DescribeInstanceTypeFamilies dipilih. Konfigurasikan parameter yang diperlukan pada tab Parameters berdasarkan referensi API pada tab Document, lalu klik Initiate Call. Pastikan nilai parameternya valid. Untuk informasi lebih lanjut, lihat Debugging Online OpenAPI.
Lihat hasil panggilan
Setelah memanggil operasi API, hasil panggilan dapat dilihat pada tab Response. Anda dapat melihat HTTP status code dan data yang dikembalikan untuk panggilan API.
Panggilan API berhasil
Umumnya, kode status HTTP yang dikembalikan adalah 200 untuk panggilan API yang berhasil. Data yang dikembalikan biasanya dalam format JSON. Arti dari setiap parameter respons dapat ditemukan di referensi API terkait. Gambar berikut menunjukkan parameter respons yang dikembalikan untuk panggilan sukses operasi DescribeInstanceTypeFamilies dari ECS.
Panggilan API gagal
Umumnya, kode status HTTP yang dikembalikan adalah 4xx untuk panggilan API yang gagal. Informasi kesalahan yang dikembalikan untuk panggilan API Alibaba Cloud yang gagal memiliki struktur seragam, kecuali untuk layanan gateway tertentu yang tidak seragam. Contoh kode berikut memberikan ilustrasi informasi kesalahan yang dikembalikan untuk panggilan gagal operasi RunInstances dari ECS:
{
"RequestId": "7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Message": "Titik akhir yang ditentukan tidak dapat mengoperasikan wilayah ini. Silakan gunakan API DescribeRegions untuk mendapatkan titik akhir yang sesuai, atau perbarui SDK Anda ke versi terbaru.(from POP)",
"Recommend": "https://api.aliyun.com/troubleshoot?q=InvalidOperation.NotSupportedEndpoint&product=Ecs&requestId=7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"HostId": "ecs-cn-hangzhou.aliyuncs.com",
"Code": "InvalidOperation.NotSupportedEndpoint"
}Parameter | Deskripsi |
RequestId | GUID permintaan, yang digunakan untuk melacak dan mengidentifikasi panggilan operasi API tertentu. Jika Anda perlu menghubungi dukungan teknis Alibaba Cloud terkait panggilan API yang gagal, berikan ID permintaan operasi API untuk membantu mengidentifikasi konteks kesalahan secara efisien. |
HostId | ID host server atau titik akhir layanan tempat kesalahan terjadi. Dalam contoh ini, kesalahan terjadi pada titik akhir instance ECS yang berada di wilayah China (Hangzhou). |
Code | Kode kesalahan. Kode kesalahan menunjukkan deskripsi singkat dan tepat tentang kesalahan. Pengembang dapat menggunakan kode kesalahan untuk menemukan makna kode dan solusi di dokumentasi Alibaba Cloud. Dalam contoh ini, kode kesalahan menunjukkan bahwa operasi API gagal dipanggil karena titik akhir yang ditentukan tidak didukung di wilayah tujuan. |
Message | Pesan kesalahan. Dalam contoh ini, pesan kesalahan menunjukkan bahwa titik akhir yang ditentukan tidak didukung di wilayah tujuan. Untuk memeriksa titik akhir yang valid, kami sarankan Anda memanggil operasi |
Recommend | URL diagnostik kesalahan yang sesuai. Anda dapat langsung menyalin URL untuk pergi ke halaman Diagnosis Masalah OpenAPI untuk mendapatkan solusi. |
Untuk informasi lebih lanjut tentang pemecahan masalah, lihat Diagnosis Kesalahan OpenAPI.
Jalankan kode contoh SDK
Untuk menjalankan kode contoh SDK dari operasi API, ikuti langkah-langkah berikut: Pada tab SDK Sample Code, pilih SDK version, pilih bahasa, lalu klik Example.
Jalankan perintah CLI
Untuk memanggil operasi API dengan menjalankan perintah CLI di Cloud Shell, klik ikon Jalankan Perintah di CloudShell di pojok kanan atas tab CLI Example.
Lihat riwayat panggilan
Riwayat panggilan operasi API dapat dilihat pada tab Call History. Untuk melihat parameter panggilan, klik Lihat parameter panggilan di kolom Tindakan panggilan. Untuk memulai panggilan ulang guna men-debug operasi API, klik redebugging di kolom Tindakan panggilan. Jika status panggilan adalah kegagalan, klik Diagnose di kolom Tindakan untuk mendiagnosis penyebab kegagalan panggilan.
Lihat kode kesalahan
Kode kesalahan yang mungkin dikembalikan untuk panggilan API beserta deskripsinya dapat dilihat pada tab Error Codes. Klik Diagnose di kolom Tindakan kode kesalahan untuk menuju halaman diagnosis masalah OpenAPI dari kesalahan yang sesuai. Kemudian, Anda dapat memeriksa dokumentasi terkait, mengunjungi forum terkait, atau menghubungi dukungan teknis untuk memecahkan kesalahan.
