Parameter umum - IoT Platform

Topik ini menjelaskan parameter permintaan umum dan parameter respons umum dari API IoT Platform.

Parameter permintaan umum

Parameter permintaan umum harus disertakan dalam semua permintaan API IoT Platform.

Parameter	Tipe	Diperlukan	Deskripsi
Format	String	Tidak.	Format dalam mana Anda ingin mengembalikan respons. Nilai valid: JSON dan XML. Nilai default: XML.
Versi	String	Ya	Nomor versi dari API. Nilainya dalam format `YYYY-MM-DD`. Nilai valid: `2018-01-20`.
AccessKeyId	String	Ya	ID AccessKey yang diberikan oleh Alibaba Cloud. Untuk membuat atau melihat pasangan AccessKey, lakukan langkah-langkah berikut: Masuk ke Alibaba Cloud Management Console, gerakkan kursor di atas foto profil, lalu klik AccessKey Management. Di halaman Pasangan AccessKey, lihat atau buat pasangan AccessKey.
Signature	String	Ya	String tanda tangan dari permintaan saat ini. Untuk informasi lebih lanjut tentang cara tanda tangan dihitung, lihat Metode tanda tangan.
SignatureMethod	String	Ya	Metode enkripsi string tanda tangan. Atur nilainya menjadi HMAC-SHA1.
Timestamp	String	Ya	Cap waktu permintaan. Tentukan waktu dalam standar ISO 8601. Waktu harus dalam UTC. Format: `YYYY-MM-DDThh:mm:ssZ`. Sebagai contoh, Anda dapat mengatur parameter ini ke `2016-01-04T12:00:00Z`, yang menunjukkan 4 Januari 2016 20:00:00 UTC+8.
SignatureVersion	String	Ya	Nomor versi algoritma enkripsi tanda tangan. Atur nilainya menjadi 1.0.
SignatureNonce	String	Ya	Nomor unik dan acak yang digunakan untuk mencegah serangan pemutaran ulang. Anda harus menggunakan nomor berbeda untuk setiap permintaan.
RegionId	String	Ya	ID wilayah tempat perangkat Anda berada. Wilayah tersebut harus sama dengan wilayah yang Anda tentukan di konsol IoT Platform. Contoh: cn-shanghai. Untuk informasi lebih lanjut tentang ID wilayah yang didukung oleh IoT Platform, lihat Wilayah yang didukung.

Contoh:

https://iot.cn-shanghai.aliyuncs.com/
?Format=XML
&Version=2018-01-20
&Signature=Pc5WB***
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=234***
&Timestamp=2018-05-20T12:00:00Z
&RegionId=cn-shanghai

Parameter respons umum

Respons API menggunakan format respons HTTP, di mana kode status 2xx menunjukkan panggilan berhasil, sedangkan kode status 4xx atau 5xx menunjukkan panggilan gagal. Respons dapat dikembalikan dalam format JSON atau XML. Anda dapat menentukan format respons dalam permintaan. Format respons default adalah XML.

Setiap respons mencakup ID permintaan unik yang ditunjukkan oleh parameter RequestId, terlepas dari apakah panggilan berhasil atau tidak.

Contoh Respons Sukses

Format XML

API IoT Platform versi 2018-01-20

<?xml version="1.0" encoding="UTF-8"?>
<!--Node root hasil-->
<Operation nama + Response>
    <!--Tag permintaan kembali-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--Data hasil kembali-->
</Nama operasi API+Response>

Format JSON

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

Contoh Respons Kesalahan
Jika terjadi kesalahan saat memanggil operasi API, tidak ada data hasil yang dikembalikan. Anda dapat menggunakan kode kesalahan untuk mengidentifikasi penyebab kesalahan.
Jika terjadi kesalahan saat memanggil operasi API, kode status HTTP 4XX atau 5XX akan dikembalikan. Pesan yang dikembalikan berisi kode kesalahan spesifik dan pesan kesalahan. Pesan tersebut juga mencakup ID permintaan unik global yang dikembalikan dalam parameter RequestId. Jika Anda tidak dapat memastikan kesalahan yang terjadi, hubungi layanan pelanggan Alibaba Cloud atau ajukan tiket. Anda harus menyertakan ID permintaan Anda untuk mendapatkan bantuan.
- Format XML
```
<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <Code>UnsupportedOperation</Code>
   <Message>The specified action is not supported.</Message>
</Error>
```
- Format JSON
```
{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}
```