このトピックでは、すべてのAPIリクエストとレスポンスに共通するパラメーターについて説明します。
共通リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 説明 |
---|---|---|---|
DdosRegionId | String | 必須 | Anti-DDoS Originインスタンスが存在するリージョンのID。
リージョンIDの詳細については、「リージョンとゾーン」をご参照ください。 |
Format | String | 任意 | 応答形式。 設定可能な値は以下のとおりです。
|
Version | String | 必須 | API のバージョン番号。 バージョン番号をYYYY-MM-DD形式で指定します。 値を2017-11-20に設定します。 |
AccessKeyId | String | 必須 | Alibaba Cloud から提供される AccessKey ID です。 |
Signature | String | 必須 | 現在のリクエストの署名文字列。 |
SignatureMethod | String | 必須 | 署名文字列の暗号化方式を設定します。 値を HMAC-SHA1 に設定します。 |
Timestamp | String | 必須 | リクエストのタイムスタンプ。 YYYY-MM-DDThh:mm:ssZ形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。
たとえば、2013-01-10T12:00:00Zを使用して、1月10日2013 20:00:00 (UTC + 8) を示します。 |
SignatureVersion | String | 必須 | 署名暗号化アルゴリズムのバージョンを設定します。 値を 1.0 に設定します。 |
SignatureNonce | String | 必須 | 反射攻撃を防ぐための、一意の乱数を設定します。 各リクエストで異なる乱数を使用する必要があります。 |
ResourceOwnerAccount | String | 任意 | アクセスするリソースが属するAlibaba Cloudアカウント。 |
例
https://ddosbgp.aliyuncs.com/?Action=DescribeOnDemandInstance
&DdosRegionId=cn-hangzhou
&InstanceId=ddosbgp-cn-xxx
&Format=xml
&バージョン=2017-11-20
&署名=xxxx % xxxx % 3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=キーテスト
&タイムスタンプ=2012-06-01T12:00:00Z
共通レスポンスパラメーター
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", /* 結果データを返す * / }