Parameter umum diperlukan dalam semua permintaan API Database Gateway. Parameter ini mencakup parameter permintaan umum dan parameter respons umum.
Parameter permintaan umum
| Parameter | Tipe | Diperlukan | Deskripsi |
| Format | String | Tidak | Format untuk mengembalikan respons. Data yang dikembalikan berada dalam format JSON. |
| Versi | String | Ya | Nomor versi API, dalam format YYYY-MM-DD. Versi saat ini adalah 2019-03-27. |
| AccessKeyId | String | Ya | ID AccessKey yang diberikan kepada Anda oleh Alibaba Cloud. |
| Signature | String | Ya | String tanda tangan untuk permintaan saat ini. Untuk informasi tentang cara menghitung tanda tangan untuk permintaan, lihat Signature. |
| Timestamp | String | Ya | Cap waktu permintaan. Tentukan waktu sesuai standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Sebagai contoh, nilai 2013-08-15T12:00:00Z menunjukkan pukul 20:00:00 pada 15 Agustus 2013, UTC+8. |
| SignatureVersion | String | Ya | Versi algoritma enkripsi tanda tangan. Atur nilainya menjadi 1.0. |
| SignatureNonce | String | Ya | Nomor acak unik yang digunakan untuk mencegah serangan replay. Anda harus menggunakan nomor acak unik untuk setiap permintaan. |
Parameter respons umum
Setiap respons mengembalikan ID permintaan unik, terlepas dari apakah panggilan berhasil atau tidak.
Contoh permintaan
https://dg.aliyuncs.com/
?Format=xml
&Version=2019-06-18
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00ZContoh respons
Respons API menggunakan format respons HTTP di mana kode status 2xx menunjukkan panggilan berhasil, sedangkan kode status 4xx atau 5xx menunjukkan panggilan gagal. Untuk panggilan yang berhasil, data yang dikembalikan berada dalam format JSON. Untuk sistem eksternal, Anda dapat mengonfigurasi parameter untuk menentukan format data yang dikembalikan saat mengonfigurasi parameter permintaan. Untuk mempermudah pembacaan, respons contoh diformat. Respons sebenarnya tidak termasuk jeda baris atau indentasi.
Format XML
<?xml version="1.0" encoding="utf-8"?>
<!--Node akar hasil-->
<Operation nama + Response>
<!--Tag permintaan pengembalian-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--Data hasil pengembalian-->
</Operation nama + Response>Format JSON
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* Data Hasil Pengembalian */
}