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

ほとんどの Alibaba Cloud API で使用される共通リクエストパラメーターを下表に示します。

表 1. 共通リクエストパラメーター
パラメーター データ型 必須 / 省略可能 説明
Format String 省略可能 レスポンスの形式。 有効値:

JSON (デフォルト) | XML

Version String 必須 API のバージョン。 日付は、YYYY-MM-DD形式です。 有効値:

2016-04-28

AccessKeyId String 必須 API を呼び出すユーザーの AccessKey ID。
Signature String 必須 リクエストの署名。
SignatureMethod String 必須 リクエスト署名の作成に使用するアルゴリズム。 有効値:

HMAC-SHA1

Timestamp String 必須 リクエストに署名する時刻。 時刻は、 YYYY-MM-DDThh:mm:ssZ形式です。

例:2013-01-10T12:00: 00Z。

SignatureVersion String 必須 使用される署名バージョン。 有効値:

1.0

SignatureNonce String 必須 ネットワーク攻撃を防ぐための署名の乱数。

リクエストごとに一意の乱数を使用する必要があります。

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

Alibaba Cloud API レスポンスの形式はすべて統一されています。 2xx 形式のステータスコードは呼び出しが成功したことを示し、4xx または 5xx 形式のステータスコードは呼び出しが失敗したことを示します。 呼び出しが成功した場合に返されるデータは XML 形式または JSON 形式にすることができます。 リクエストを送信する際に、返される結果データの形式を指定することができます。 デフォルトの形式は XML です。

リクエストが成功したかどうかに関係なく、 RequestId が返されます。
  • XML 形式
    <? xml version="1.0" encoding="utf-8"?  > 
        <!—The root node of the result-->
        <Action+Response>
            <!—The returned result-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!—The returned result-->
        </Action+Response>
    					
  • JSON 形式
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*The returned result*/
        }