Parameter umum - - 阿里云

Topik ini menjelaskan parameter permintaan umum dan parameter respons umum dari operasi API ApsaraMQ for RocketMQ.

Parameter permintaan umum

Parameter permintaan umum harus disertakan dalam semua permintaan API Antrian Pesan untuk Apache RocketMQ.

Parameter	Tipe	Diperlukan	Deskripsi
Format	String	Tidak	Format respons yang akan dikembalikan. Nilai valid: JSON dan XML. Nilai default: XML.
productName	String	Ya	Nama API. Masukkan Ons.
Domain	String	Ya	Domain Titik akhir API. Nilainya dalam format `ons.${RegionId}.aliyuncs.com`. Wilayah yang ditentukan dengan parameter domain harus konsisten dengan yang ditentukan dengan parameter regionId.
Version	String	Ya	Nomor versi API. Nilainya harus dalam format YYYY-MM-DD. Contoh nilai: 2019-02-14.
AccessKeyId	String	Ya	Pasangan AccessKey yang diberikan kepada Anda oleh Alibaba Cloud. Jika Anda menggunakan akun Alibaba Cloud atau pengguna RAM untuk memanggil operasi API, parameter ini adalah ID AccessKey dan Rahasia AccessKey dari akun Alibaba Cloud atau pengguna RAM tersebut. Jika Anda menggunakan pengguna RAM untuk memanggil operasi API, parameter ini adalah ID AccessKey dan Rahasia AccessKey dalam Token Layanan Keamanan (STS) yang Anda peroleh. Untuk informasi lebih lanjut, lihat Berikan izin kepada pengguna RAM.
AccessKeySecret	String	Ya
Signature	String	Ya	String tanda tangan dari permintaan saat ini.
SignatureMethod	String	Ya	Metode enkripsi string tanda tangan. Atur nilainya ke HMAC-SHA1.
Timestamp	String	Ya	Cap waktu permintaan. Tentukan waktu dalam standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Sebagai contoh, pukul 20:00:00 pada tanggal 10 Januari 2013 (UTC+8) ditulis sebagai 2013-01-10T12:00:00Z.
SignatureVersion	String	Ya	Versi algoritma enkripsi tanda tangan. Atur nilainya ke 1.0.
SignatureNonce	String	Ya	Angka unik dan acak yang digunakan untuk mencegah serangan pemutaran ulang. Anda harus menggunakan angka berbeda untuk setiap permintaan.

Contoh Permintaan

https:/ons.cn-hangzhou.aliyuncs.com/? Action=OnsRegionList
&Format=JSON
&Version=2019-02-14
&AccessKeyId=key-test
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&Timestamp=2020-01-01T12:00:00Z
&SignatureNonce=1521552885****
&SignatureVersion=1.0
...

Parameter respons umum

Setiap respons mengembalikan RequestID unik, terlepas dari apakah panggilan berhasil atau tidak. Respons dikembalikan dalam format yang seragam. API menggunakan format respons HTTP, di mana kode status 2xx menunjukkan panggilan berhasil, sedangkan kode status 4xx atau 5xx menunjukkan panggilan gagal.

Format XML

<? xml version="1.0" encoding="UTF-8"? >
<!--Node Root Hasil-->
<Interface Nama+Respons>
 | <!--Tag Permintaan Kembali-->
 | <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
 | <!--Data Hasil Kembali-->
</Interface Nama+Respons>

Format JSON

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* Data Hasil Kembali */
}