Parameter umum - - 阿里云

Topik ini menjelaskan parameter umum yang berlaku untuk semua permintaan dan respons API Antrian Pesan untuk MQTT.

Parameter permintaan umum

Tabel 1. Tabel Parameter Permintaan Umum

Parameter	Tipe	Diperlukan	Deskripsi
Format	String	Tidak	Format respons. Nilai valid: JSON XML
Versi	String	Ya	Nomor versi API. Tentukan nomor versi dalam format YYYY-MM-DD. Nilai valid: 2020-04-20
AccessKeyId	String	Ya	ID AccessKey dari akun Alibaba Cloud Anda. Untuk informasi tentang cara memperoleh ID AccessKey, lihat Memperoleh pasangan AccessKey.
Signature	String	Ya	String tanda tangan dari permintaan saat ini. Untuk informasi tentang cara menghitung tanda tangan, lihat Metode tanda tangan.
SignatureMethod	String	Ya	Metode enkripsi string tanda tangan. Tetapkan nilai 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, gunakan 2013-01-10T12:00:00Z untuk menentukan 20:00:00 pada 10 Januari 2013 (UTC+8).
SignatureVersion	String	Ya	Versi algoritma enkripsi tanda tangan. Tetapkan nilai ke 1.0
SignatureNonce	String	Ya	Nomor unik dan acak yang digunakan untuk mencegah serangan replay. Anda harus menggunakan nomor acak unik untuk setiap permintaan.
ResourceOwnerAccount	String	Tidak	Akun Alibaba Cloud tempat sumber daya yang ingin Anda akses berada.

Contoh permintaan

http://onsmqtt.[regionId].aliyuncs.com/?Action=[ApiName]
&TimeStamp=2020-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE****
&Version=2020-04-20
&SignatureVersion=1.0
&Signature=[Signature]

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 XML. Setiap respons mengembalikan RequestId yang unik, terlepas dari apakah panggilan berhasil atau tidak.

Kode status HTTP 2xx menunjukkan panggilan berhasil.
Kode status HTTP 4xx atau 5xx menunjukkan panggilan gagal.

Contoh Respons Sukses

Setiap respons sukses mencakup parameter respons dan ID permintaan. Dalam respons sukses, kode status HTTP adalah 2xx.

Format XML

<?xml version="1.0" encoding="utf-8"?> 
    <!--Node root dari respons-->
    <Operation name+Response>
        <!--Tag permintaan yang dikembalikan-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--Data yang dikembalikan-->
    </Operation name+Response>

Format JSON

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*Data yang dikembalikan*/
    }

Contoh Respons Kesalahan

Jika terjadi kesalahan saat memanggil operasi, respons kesalahan yang mencakup kode kesalahan, pesan kesalahan, dan ID permintaan akan dikembalikan. Dalam respons kesalahan, kode status HTTP adalah 4xx atau 5xx. Anda dapat menyelesaikan masalah berdasarkan kode kesalahan. Untuk informasi lebih lanjut, lihat Kode Kesalahan. Jika Anda tidak dapat menyelesaikan masalah berdasarkan kode kesalahan, hubungi dukungan teknis ApsaraMQ for MQTT.

Format XML

<?xml version="1.0" encoding="UTF-8"?><!--Node root dari respons-->
<Error>
    <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!--ID Permintaan-->
    <Code>MissingParameter.CommandId</Code> <!--Kode kesalahan-->
    <Message>Parameter input "CommandId" yang wajib untuk memproses permintaan ini tidak disediakan.</Message> <!--Pesan kesalahan-->
</Error>

Format JSON

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* ID Permintaan */
    "Code": "MissingParameter.CommandId", /* Kode kesalahan */
    "Message": "Parameter input "CommandId" yang wajib untuk memproses permintaan ini tidak disediakan." /* Pesan kesalahan */
}