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

このトピックでは、PolarDB-Xの各API操作を呼び出すために使用できる共通パラメーターについて説明します。共通パラメータには、リクエストパラメータとレスポンスパラメータがあります。

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

パラメーター	データ型	必須	説明
Format	String	任意	レスポンスを返す形式を設定します。有効な値 : JSON と XML。デフォルト値：JSON。
Version	String	必須	API のバージョン番号です。バージョン番号をYYYY-MM-DD形式で指定します。値を2020-02-02に設定します。
AccessKeyId	String	必須	PolarDB-Xへの接続に使用されるAccessKey ID。
Signature	String	必須	現在のリクエストの署名の文字列です。
SignatureMethod	String	必須	署名文字列の暗号化方式を設定します。値を HMAC-SHA1 に設定します。
Timestamp	String	必須	リクエストのタイムスタンプです。 ISO 8601標準の時刻を`yyyy-MM-ddTHH:mm:ssZ`形式で指定します。時刻は UTC である必要があります。たとえば、1月10日の20:00:00 (UTC + 8) を指定する場合、タイムスタンプの値として2013の値を2013-01-10T12:00:00Zに設定します。
SignatureVersion	String	必須	署名暗号化アルゴリズムのバージョンを設定します。値を 1.0 に設定します。
SignatureNonce	String	必須	リプレイ攻撃を防ぐための、一意の乱数を設定します。各リクエストで異なる乱数を使用する必要があります。
ResourceOwnerAccount	String	任意	アクセスするリソースを所有するアカウントの名前。このアカウントを使用してPolarDB-Xにログインし、API操作を呼び出すことができます。

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

API のレスポンスは HTTP レスポンス形式です。応答はJSONまたはXML形式で返すことができます。リクエストでレスポンスの形式を指定できます。デフォルトのレスポンス形式は XML です。各応答は、呼び出しが成功したかどうかに関係なく、一意のRequestIdを返します。

2xxステータスコードは、呼び出しが成功したことを示します。
4xxまたは5xxステータスコードは、呼び出しの失敗を示します。

レスポンス例：

XML形式

<?xml version="1.0" encoding="utf-8"?> 
    <!--Result Root Node-->
    <Interface Name+Response>
        <!-- Return Request Tag -->
        <RequestId>4C467B38-3910-447D-87BC-AC0491 ******</RequestId>
        <!-- 結果データを返す -->
    </インタフェース名 + 応答>

JSON形式

{
    "RequestId":"4C467B38-3910-447D-87BC-AC0491 *******" 、
    /* 結果データを返す * /
    }