Tüm WAF API istekleri ve yanıtları bir dizi ortak parametre içerir. Bu sayfada söz konusu parametreler açıklanır ve düzgün biçimlendirilmiş bir istek ile yanıt örneği gösterilir.
Ortak istek parametreleri
Her API isteğine aşağıdaki parametreleri ekleyin.
| Parametre | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| Format | String | Hayır | Yanıt biçimi. Geçerli değerler: JSON, XML. Varsayılan: XML. |
| Version | String | Evet | YYYY-AA-GG biçimindeki API sürümü. Değeri 2019-09-10 olarak ayarlayın. |
| AccessKeyId | String | Evet | AccessKey ID'niz. |
| Signature | String | Evet | Geçerli isteğin imza dizesi. |
| SignatureMethod | String | Evet | İmzalama algoritması. Değeri HMAC-SHA1 olarak ayarlayın. |
| Timestamp | String | Evet | ISO 8601 biçimindeki istek zaman damgası: YYYY-MM-DDThh:mm:ssZ (UTC). Örnek: 2013-01-10T12:00:00Z ifadesi, UTC+8 saat dilimine göre 10 Ocak 2013, 20:00:00 tarihini temsil eder. |
| SignatureVersion | String | Evet | İmzalama algoritması sürümü. Değeri 1.0 olarak ayarlayın. |
| SignatureNonce | String | Evet | Tekrar saldırılarını önleyen benzersiz rastgele dize. Her istek için farklı bir değer kullanın. |
| ResourceOwnerAccount | String | Hayır | Erişilecek kaynağa sahip Alibaba Cloud hesabı. |
Örnek istek
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
Ortak yanıt parametreleri
WAF API yanıtları standart HTTP kurallarını izler:
2xx — çağrı başarılı oldu.
4xx veya 5xx — çağrı başarısız oldu.
Çağrının başarılı olup olmadığından bağımsız olarak her yanıt bir RequestId içerir. Yanıtlar JSON veya XML biçiminde döndürülür. Varsayılan biçim XML'dir; bunu değiştirmek için Format istek parametresini ayarlayın.
Örnek yanıtlar
XML biçimi
<?xml version="1.0" encoding="utf-8"?>
<!--Result root node-->
<InterfaceNameResponse>
<!--Request tag-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--Return result data-->
</InterfaceNameResponse>
JSON biçimi
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
/*Return result data*/
}