ApsaraMQ for RabbitMQ memungkinkan Anda memanggil operasi API menggunakan HTTP, SDK, dan OpenAPI Explorer.
Gunakan HTTP
Untuk memanggil operasi API melalui HTTP, kirimkan permintaan HTTP GET ke endpoint ApsaraMQ for RabbitMQ. Tambahkan parameter permintaan yang sesuai dengan operasi API yang dipanggil. Setelah pemanggilan, sistem akan mengembalikan respons dalam format UTF-8. Operasi API ApsaraMQ for RabbitMQ menggunakan protokol RPC dan dapat dipanggil melalui permintaan HTTP GET.
Berikut adalah sintaksis permintaan yang digunakan:
https://Endpoint/?Action=xx&ParametersDeskripsi Parameter:
Endpoint: Titik akhir untuk mengakses operasi API ApsaraMQ for RabbitMQ. Untuk informasi lebih lanjut, lihat Titik Akhir.
Action: Operasi API yang akan dipanggil. Sebagai contoh, untuk menanyakan instans ApsaraMQ for RabbitMQ yang telah dibuat, atur parameter ini menjadi ListInstances.
Version: Nomor versi API ApsaraMQ for RabbitMQ. Atur nilainya menjadi 2019-12-12.
Parameters: Parameter permintaan. Pisahkan beberapa parameter dengan tanda ampersand (&).
Parameter permintaan mencakup parameter umum dan spesifik operasi. Parameter umum mencakup nomor versi API dan informasi autentikasi. Untuk informasi lebih lanjut, lihat bagian berikutnya.
Parameter Umum
Parameter Permintaan Umum
Parameter | Tipe | Diperlukan | Deskripsi |
Format | String | Tidak | Format respons. Nilai valid: JSON dan XML. Nilai default: JSON. |
Version | String | Ya | Nomor versi dari API. Tentukan nomor versi dalam format YYYY-MM-DD. Atur nilai menjadi 2019-12-12 |
AccessKeyId | String | Ya | ID AccessKey yang digunakan untuk mengakses ApsaraMQ for RabbitMQ. |
Signature | String | Ya | String tanda tangan dari permintaan saat ini. |
SignatureMethod | String | Ya | Metode enkripsi string tanda tangan. Atur parameter ini menjadi HMAC-SHA1 |
Timestamp | String | Ya | Cap waktu permintaan. Tentukan nilai dalam standar ISO 8601 dalam format YYYY-MM-DDThh:mm:ssZ. Waktu harus dalam UTC. Contoh: 2013-01-10T20:00:00Z, yang menentukan pukul 20:00:00 pada tanggal 10 Januari 2013 (UTC+8). |
SignatureVersion | String | Ya | Versi algoritma tanda tangan. Atur parameter ini menjadi 1.0 |
SignatureNonce | String | Ya | Nomor unik dan acak yang digunakan untuk mencegah serangan replay. Anda harus menggunakan nomor berbeda untuk setiap permintaan. Kami merekomendasikan penggunaan pengenal unik universal (UUID). |
ResourceOwnerAccount | String | Tidak | Akun Alibaba Cloud tempat sumber daya yang ingin Anda akses berada. |
Contoh
https://amqp-open.aliyuncs.com/?Action=ListInstances
&Format=JSON
&Version=2019-12-12
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e7b1f31150be45594905ce6d28561286
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2020-02-10T08%3A43%3A05Z
...Parameter Respons Umum
Respons API menggunakan format respons HTTP. Respons dapat dikembalikan dalam format JSON atau XML. Anda dapat menentukan format respons dalam permintaan. Format respons default adalah JSON. Setiap respons mengembalikan ID permintaan unik yang ditunjukkan oleh parameter RequestId, terlepas dari apakah permintaan berhasil atau tidak.
Kode status HTTP
2xxmenunjukkan bahwa permintaan berhasil.Kode status HTTP
4xxatau5xxmenunjukkan bahwa permintaan gagal.
Contoh respons
Format XML
<?xml version="1.0" encoding="utf-8"?> <!--Node root dari respons--> <Interface name+Response> <!--Tag permintaan yang dikembalikan--> <RequestId>D6660A81-1A96-43F3-AC00-4EE473C70AEC</RequestId> <!--Data yang dikembalikan--> </Interface name+Response>Format JSON
{ "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC", /*Data yang dikembalikan*/ }
Gunakan SDK
ApsaraMQ for RabbitMQ menyediakan SDK untuk berbagai bahasa pemrograman. SDK secara otomatis menandatangani permintaan untuk Anda. Tabel berikut menyediakan tautan unduhan dan dokumentasi terkait SDK ApsaraMQ for RabbitMQ untuk berbagai bahasa pemrograman.
Bahasa pemrograman | Tautan unduhan | Referensi |
Java | ||
Go | ||
Python | ||
PHP |
Gunakan OpenAPI Explorer
OpenAPI Explorer adalah alat GUI untuk memanggil operasi API. Anda dapat menggunakan OpenAPI Explorer untuk memanggil operasi API layanan Alibaba Cloud dan operasi API yang disediakan di Alibaba Cloud API Marketplace. Anda dapat memanggil operasi API pada halaman web atau antarmuka baris perintah (CLI). Anda juga dapat menggunakan OpenAPI Explorer untuk melihat parameter permintaan dan respons dari setiap panggilan API. OpenAPI Explorer secara dinamis menghasilkan kode contoh untuk berbagai SDK. Untuk mengakses OpenAPI Explorer, klik OpenAPI Explorer.