すべてのプロダクト
Search
ドキュメントセンター

PolarDB:共通パラメーター

最終更新日:May 30, 2024

このトピックでは、すべてのPolarDB-X 1.0 PolarDB-X API操作に必要なリクエストパラメーターとレスポンスパラメーターについて説明します。

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

パラメーターデータ型必須説明
FormatString任意レスポンスを返す形式を設定します。 有効な値 : JSON と XML。 デフォルト値:JSON。
VersionString必須YYYY-MM-DD形式のAPIのバージョン番号。 値を2019-01-23に設定します。
AccessKeyIdString必須Alibaba Cloud から提供された AccessKey ID です。
SignatureString必須現在のリクエストの署名の文字列です。
SignatureMethodString必須署名文字列の暗号化方式を設定します。 値を HMAC-SHA1 に設定します。
TimestampString必須リクエストのタイムスタンプです。 時刻を ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ) の形式で指定します。 時刻は UTC である必要があります。

たとえば、2013-01-10T12:00:00Zは、2013年1月10日の20:00:00 (UTC + 8) を指定します。

SignatureVersionString必須署名暗号化アルゴリズムのバージョンを設定します。 値を 1.0 に設定します。
SignatureNonceString必須リプレイ攻撃を防ぐための、一意の乱数を設定します。 各リクエストで異なる乱数を使用する必要があります。
ResourceOwnerAccountString任意このリクエストによってアクセスされるリソースを所有するアカウント。

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

レスポンスデータは JSON 形式または XML 形式のいずれかで返されます。 リクエストでレスポンスの形式を指定できます。 デフォルトの応答形式はJSONです。 呼び出しの成否に関わらず、すべてのレスポンスで一意の RequestId が返されます。
  • HTTP 2xxステータスコードは、呼び出しが成功したことを示します。
  • HTTP 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 *******" 、
        /* 応答データ * /
        }