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

共通パラメータには、共通リクエストパラメータと共通レスポンスパラメータがあります。

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

すべての仮想プライベートクラウド (VPC) APIリクエストに共通リクエストパラメーターを含める必要があります。共通リクエストパラメーターを次の表に示します。

項目	データ型	必須／任意	説明
Format	String	任意	レスポンスを返す形式を設定します。有効な値： JSONとXMLをします。デフォルト値: JSON。
Version	String	必須	API のバージョン番号。形式: `YYYY-MM-DD` 有効な値： 2016-04-28
AccessKeyId	String	必須	VPC APIの呼び出しに使用されるAccessKey ID。
Signature	String	必須	現在のリクエストの署名文字列。
SignatureMethod	String	必須	署名文字列の暗号化方式を設定します。値を HMAC-SHA1
Timestamp	String	必須	リクエストのタイムスタンプ。時刻を ISO 8601 規格 `(yyyy-MM-ddTHH:mm:ssZ)` の形式で指定します。時間は UTC にする必要があります。たとえば、2022-01-10T01:00:00Zを使用して、2022年1月10日09: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"?> 
    <!-- 結果ルートノード -->
    <操作名 + レスポンス>
        <!-- 返されたリクエストタグ -->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!-- 返されたデータ -->
    </操作名 + レスポンス>

JSON 形式

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /* 返されたデータ * /
}