すべてのプロダクト
Search
ドキュメントセンター

Web Application Firewall:共通パラメーター

最終更新日:May 24, 2024

このトピックでは、すべてのAPIリクエストとレスポンスに共通するパラメーターについて説明します。

共通リクエストパラメーター

パラメーターデータ型必須/任意説明
FormatString任意応答形式。 設定可能な値は以下のとおりです。
  • JSON (デフォルト)
  • XML
VersionString必須API のバージョン番号。 バージョン番号をYYYY-MM-DD形式で指定します。 値を2019-09-10に設定します。
AccessKeyIdString必須Alibaba Cloud から提供される AccessKey ID です。
SignatureString必須現在のリクエストの署名文字列。
SignatureMethodString必須署名文字列の暗号化方式を設定します。 値を HMAC-SHA1 に設定します。
TimestampString必須リクエストのタイムスタンプ。 時刻を ISO 8601 規格の形式 (YYYY-MM-DDThh:mm:ssZ) で指定します。 時間は UTC にする必要があります。

たとえば、2013-01-10T12:00:00Zを使用して、2013年1月10日20:00:00 (UTC + 8) を示します。

SignatureVersionString必須署名暗号化アルゴリズムのバージョンを設定します。 値を 1.0 に設定します。
SignatureNonceString必須反射攻撃を防ぐための、一意の乱数を設定します。

各リクエストで異なる乱数を使用する必要があります。

ResourceOwnerAccountString任意アクセスするリソースが属するAlibaba Cloudアカウント。
https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=DescribeDomainNames
&リージョン=cn
&InstanceId=waf_elasticity-cn-0xldbqtm005
&タイムスタンプ=2014-05-19T10% 3A33% 3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&バージョン=2019-09-10
&SignatureVersion=1.0
&署名= 署名

共通レスポンスパラメーター

API レスポンスは HTTP レスポンス形式を使用します。ステータスコードが 2XX の場合は呼び出しの成功を示し、ステータスコードが 4XX または 5XX の場合は呼び出しの失敗を示します。 すべての応答は、呼び出しが成功したかどうかに関係なく、一意のRequestIDを返します。

レスポンスデータは JSON 形式または XML 形式のいずれかで返されます。 リクエストでレスポンスの形式を指定できます。 デフォルトのレスポンス形式は XML です。

正常に処理された場合のレスポンス例
  • XML 形式
    <?xml version="1.0" encoding="utf-8"?> 
        <!--Result Root Node-->
        <Interface Name+Response>
            <!-- Return Request Tag -->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!-- 結果データを返す -->
        </Interface Name+Response>   
  • JSON 形式
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /* 結果データを返す * /
        }