Parameter umum - Web Application Firewall

Topik ini menjelaskan parameter yang umum digunakan dalam semua permintaan dan respons API.

Parameter permintaan umum

Parameter	Tipe	Diperlukan	Deskripsi
Format	String	Tidak	Format respons. Nilai valid: JSON XML (default)
Version	String	Ya	Nomor versi API. Tentukan nomor versi dalam format YYYY-MM-DD. Atur nilai menjadi 2019-09-10.
AccessKeyId	String	Ya	ID AccessKey yang diberikan kepada Anda oleh Alibaba Cloud.
Signature	String	Ya	String tanda tangan dari permintaan saat ini.
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 dalam format YYYY-MM-DDThh:mm:ssZ. Waktu harus dalam UTC. Sebagai contoh, gunakan 2013-01-10T12:00:00Z untuk menunjukkan 10 Januari 2013, 20:00:00 (UTC+8).
SignatureVersion	String	Ya	Versi algoritma enkripsi tanda tangan. Atur nilainya menjadi 1.0.
SignatureNonce	String	Ya	Nomor unik dan acak yang digunakan untuk mencegah serangan replay. Anda harus menggunakan nomor berbeda untuk setiap permintaan.
ResourceOwnerAccount	String	Tidak	Akun Alibaba Cloud yang memiliki sumber daya yang ingin Anda akses.

Contoh

https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=DescribeDomainNames
&Region=cn
&InstanceId=waf_elasticity-cn-0xldbqtm005
&Timestamp=2013-01-10T12:00:00Z
&Format=xml
&AccessKeyId=********
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2019-09-10
&SignatureVersion=1.0
&Signature=Signature

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

Respons dapat dikembalikan dalam format JSON atau XML. Anda dapat menentukan format respons dalam permintaan. Format respons default adalah XML.

Contoh Respons Sukses

Format XML

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

Format JSON

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