每個介面都需要使用的請求參數和返回資料 - Web Application Firewall

本文介紹每個介面都需要使用的請求參數和返回資料。

公用請求參數

名稱	類型	是否必須	描述
Format	String	否	返回訊息的格式。取值： JSON（預設） XML
Version	String	是	API版本號碼，使用YYYY-MM-DD日期格式。取值： 2019-09-10
AccessKeyId	String	是	訪問服務使用的密鑰ID。
Signature	String	是	簽名結果串。
SignatureMethod	String	是	簽名方式，取值： HMAC-SHA1
Timestamp	String	是	請求的時間戳記，為日期格式。使用UTC時間，按照 ISO 8601標準，格式為YYYY-MM-DDThh:mm:ssZ。例如，北京時間2013年1月10日20點0分0秒，表示為2013-01-10T20:00:00Z。
SignatureVersion	String	是	簽名演算法版本，取值： 1.0
SignatureNonce	String	是	唯一隨機數，用於防止網路重放攻擊。在不同請求間要使用不同的隨機數值。
ResourceOwnerAccount	String	否	本次API請求訪問到的資源擁有者帳號，即登入使用者名稱。

樣本

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

公用返回資料

API返回結果採用統一格式，返回2xx HTTP狀態代碼表示調用成功，返回4xx或5xx HTTP狀態代碼表示調用失敗。每次介面調用，無論成功與否，系統都會返回一個唯一識別碼RequestId，用於標識本次請求。

調用成功返回的資料格式有XML和JSON兩種。您可以在發送請求時指定返回的資料格式，預設為XML格式。

正常返回資料樣本：

XML格式

<?xml version="1.0" encoding="utf-8"?> 
    <!--結果的根結點-->
    <介面名稱+Response>
        <--返回請求標籤-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--返回結果資料-->
    </介面名稱+Response>

JSON格式

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*返回結果資料*/
    }