PolarDB-X API リクエストでは、認証のために共通パラメーターを指定する必要があります。また、すべての操作において、応答は一貫した構造で返されます。
共通リクエストパラメーター
すべての API リクエストに、以下のパラメーターを含めてください。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
Format | 文字列 | いいえ | 応答フォーマット。有効な値： JSON、XML。デフォルト値： JSON。 |
Version | 文字列 | はい | API のバージョン（YYYY-MM-DD 形式）。値は 2020-02-02 に設定します。 |
AccessKeyId | 文字列 | はい | PolarDB-X への認証に使用する AccessKey ID です。 |
Signature | 文字列 | はい | 現在のリクエストに対する署名文字列です。 |
SignatureMethod | 文字列 | はい | 署名暗号化アルゴリズム。値は HMAC-SHA1 に設定します。 |
Timestamp | 文字列 | はい | ISO 8601 形式のリクエストタイムスタンプ：yyyy-MM-ddTHH:mm:ssZ（UTC）。たとえば、2013-01-10T12:00:00Z は、2013 年 1 月 10 日の UTC+8 時間で 20:00:00 を表します。 |
SignatureVersion | 文字列 | はい | 署名アルゴリズムのバージョン。値は 1.0 に設定します。 |
SignatureNonce | 文字列 | はい | リプレイ攻撃を防止するための一意の乱数です。各リクエストで異なる値を使用してください。 |
ResourceOwnerAccount | 文字列 | いいえ | リソースの所有者アカウント名です。他のアカウントを使用して API オペレーションを呼び出す場合に指定します。 |
共通レスポンスパラメーター
API 応答は HTTP 応答フォーマットで返され、JSON または XML 形式で取得できます。Format リクエストパラメーターを用いて応答フォーマットを指定します。デフォルトの応答フォーマットは XML です。
すべての応答には、呼び出しの成否に関わらず、一意の RequestId が含まれます：
2xxの状態コードは成功を示します。4xxまたは5xxの状態コードは失敗を示します。
XML 形式の応答例：
<?xml version="1.0" encoding="utf-8"?>
<!--Result Root Node-->
<InterfaceNameResponse>
<!--Return Request Tag-->
<RequestId>4C467B38-3910-447D-87BC-AC0491******</RequestId>
<!--Return Result Data-->
</InterfaceNameResponse>JSON 形式の応答例：
{
"RequestId": "4C467B38-3910-447D-87BC-AC0491******"
}