Pelajari cara mendebug operasi API Alibaba Cloud secara online di OpenAPI Explorer.
Buat Akun Alibaba Cloud
Pemanggilan API memerlukan Akun Alibaba Cloud. Jika Anda belum memilikinya, daftarlah di situs web resmi Alibaba Cloud.
Aktifkan Layanan Alibaba Cloud
Aktifkan layanan Alibaba Cloud yang ingin Anda gunakan. Contoh berikut menggunakan Short Message Service (SMS):
-
Buka User Center, cari Short Message Service, lalu klik Activate.
-
Buka konsol layanan, seperti SMS console, lalu klik Activate.
Anda harus mengaktifkan layanan Alibaba Cloud sebelum memanggil operasi API-nya.
Debug operasi API secara online
Masuk ke OpenAPI Explorer, pilih layanan Alibaba Cloud yang telah diaktifkan, seperti ECS, lalu klik Debug.
Pilih operasi API yang akan didebug, misalnya DescribeInstanceTypeFamilies untuk ECS. Di bagian Parameters, masukkan nilai sesuai yang dijelaskan pada tab Document, lalu klik Initiate Call. Debugging online OpenAPI.
Response
Tab Response menampilkan HTTP status code dan data yang dikembalikan oleh panggilan tersebut.
Tab ini juga menampilkan informasi Request Header dan Response Header.
Panggilan berhasil
Panggilan yang berhasil mengembalikan HTTP status code 200 dengan respons JSON. Setiap parameter dijelaskan dalam dokumentasi API, seperti referensi DescribeInstanceTypeFamilies.
Panggilan gagal
Panggilan yang gagal mengembalikan HTTP status code dalam rentang 4xx. API Alibaba Cloud menggunakan struktur respons kesalahan terpadu, kecuali beberapa layanan yang tidak menggunakan gerbang standar. Contoh berikut menunjukkan format kesalahan untuk operasi RunInstances dari ECS:
{
"RequestId": "7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Message": "The specified endpoint cant operate this region. Please use API DescribeRegions to get the appropriate endpoint, or upgrade your SDK to latest version.(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 |
ID permintaan unik global. Berikan |
|
HostId |
Titik akhir layanan tempat terjadinya kesalahan. Dalam contoh ini, yaitu titik akhir ECS di wilayah China (Hangzhou). |
|
Code |
Identifikasi singkat untuk jenis kesalahan. Cari kode ini di dokumentasi Alibaba Cloud untuk solusinya. Dalam contoh ini, titik akhir tidak mendukung wilayah target. |
|
Message |
Pesan kesalahan detail. Dalam contoh ini, titik akhir tidak mendukung wilayah yang dipilih. Gunakan API |
|
Recommend |
URL diagnostik. Buka tautan ini untuk mengunjungi OpenAPI Troubleshoot guna mencari solusi. |
Untuk memecahkan masalah kesalahan, gunakan OpenAPI Troubleshoot.
Kode contoh SDK
Di tab SDK sample code, pilih SDK version dan bahasa, lalu klik Run Example.
Anda juga dapat mengklik View Version Differences untuk membandingkan versi SDK, Download Full Project untuk mengunduh kode, atau mengaktifkan Generate Example in Common Mode untuk mengganti mode pembuatan.
Contoh CLI
Riwayat panggilan
Tab Call History mencantumkan riwayat panggilan API Anda sebelumnya. Tinjau parameter dan klik Redebug untuk menjalankan ulang panggilan tersebut. Jika status panggilan gagal, gunakan Diagnose untuk mengidentifikasi penyebabnya.
Di tab CLI example, klik tombol run untuk mendebug perintah secara online.
Kode kesalahan
Tab Error Codes mencantumkan kemungkinan kesalahan beserta deskripsinya. Klik Diagnose untuk membuka halaman diagnosis, yang menyediakan dokumen relevan, diskusi forum, dan dukungan.
Sebagai contoh, memasukkan RegionId yang tidak valid mengembalikan HTTP status code 404, kode kesalahan InvalidRegionId.NotFound, dan pesan The RegionId provided does not exist in our records..