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

すべてのAPI操作で共通のリクエストパラメーターが必要です。

表 1. 共通リクエストパラメーター
項目 データ型 必須／任意 説明　
Format String 任意 応答が返される形式。 有効な値：

JSONとXMLをします。 デフォルト値: JSON。
Version String 必須 API のバージョン番号。 形式: YYYY-MM-DD 値を次のように設定します。

2016-04-28
AccessKeyId String 必須 Alibaba Cloud から提供された AccessKey ID。
Signature String 必須 APIリクエストの署名文字列。
SignatureMethod String 必須 署名文字列の暗号化方式を設定します。 値を次のように設定します。

HMAC-SHA1
Timestamp String 必須 リクエストのタイムスタンプ。 YYYY-MM-DDThh:mm:ssZ形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

例: 2013-01-10T12:00:00Z。これは、2013年1月10日の20:00:00 (UTC 8) を示します。
SignatureVersion String 必須 署名暗号化アルゴリズムのバージョンを設定します。 値を次のように設定します。

1.0
SignatureNonce String 必須 リプレイ攻撃を防ぐために使用される一意の乱数。

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

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

API のレスポンスは HTTP レスポンス形式です。 2XXステータスコードは呼び出しの成功を示し、4XXまたは5XXステータスコードは呼び出しの失敗を示します。 応答はJSONまたはXML形式で返すことができます。 デフォルトの応答形式はJSONです。 操作を呼び出すときに形式を指定できます。

各応答は、呼び出しが成功したかどうかに関係なく、一意のRequestIdを返します。
  • XML 形式 
    <? xml version="1.0" encoding="utf-8"? > 
    <!—Result root node-->
    <Operation name+Response>
        <!-リクエストID -->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!-返されたデータ -->
    </API operation name+response>
  • JSON 形式 
    {
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /* 返されたデータ * /
    }