共通パラメーター - Web Application Firewall - Alibaba Cloud ドキュメントセンター

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

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

パラメーター	タイプ	必須	説明
Format	String	いいえ	レスポンスフォーマット。有効な値： JSON XML (デフォルト)
Version	String	はい	API のバージョン番号。 YYYY-MM-DD 形式でバージョン番号を指定します。2019-09-10 に設定します。
AccessKeyId	String	はい	Alibaba Cloud から提供された AccessKey ID。
Signature	String	はい	現在のリクエストの署名文字列。
SignatureMethod	String	はい	署名文字列の暗号化方式。HMAC-SHA1 に設定します。
Timestamp	String	はい	リクエストのタイムスタンプ。ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式で時間を指定します。時間は UTC でなければなりません。たとえば、2013-01-10T12:00:00Z は、2013 年 1 月 10 日 20:00:00 (UTC + 08:00) を示します。
SignatureVersion	String	はい	署名暗号化アルゴリズムのバージョン。1.0 に設定します。
SignatureNonce	String	はい	リプレイ攻撃を防ぐために使用される一意の乱数。リクエストごとに異なる番号を使用する必要があります。
ResourceOwnerAccount	String	いいえ	アクセスするリソースが属する Alibaba Cloud アカウント。

例

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

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

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>
        <!--Return Result Data-->
    </Interface Name+Response>

JSON 形式

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