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

Database Gateway - Deprecated:共通パラメーター

最終更新日:Jan 19, 2025

共通パラメーターは、すべてのデータベースゲートウェイ API リクエストで必須です。共通パラメーターには、共通リクエストパラメーターと共通レスポンスパラメーターが含まれます。

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

パラメータータイプ必須説明
FormatStringいいえレスポンスを返す形式。返されるデータは JSON 形式です。
VersionStringはいAPI のバージョン番号。YYYY-MM-DD 形式。現在のバージョンは 2019-03-27 です。
AccessKeyIdStringはいAlibaba Cloud から提供された AccessKey ID。
SignatureStringはい現在のリクエストの署名文字列。リクエストの署名の計算方法については、「署名」をご参照ください。
TimestampStringはいリクエストのタイムスタンプ。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時間を指定します。時間は UTC でなければなりません。たとえば、2013-08-15T12:00:00Z の値は、UTC + 08:00 の 2013 年 8 月 15 日 20:00:00 を示します。
SignatureVersionStringはい署名暗号化アルゴリズムのバージョン。値を 1.0 に設定します。
SignatureNonceStringはいリプレイ攻撃を防ぐために使用される一意の乱数。リクエストごとに一意の乱数を使用する必要があります。

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

すべてのレスポンスは、呼び出しが成功したかどうかに関係なく、一意のリクエスト ID を返します。

サンプルリクエスト

https://dg.aliyuncs.com/
?Format=xml
&Version=2019-06-18
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z

サンプルレスポンス

API レスポンスは HTTP レスポンス形式を使用します。2xx の状態コードは呼び出しの成功を示し、4xx または 5xx の状態コードは呼び出しの失敗を示します。成功した呼び出しの場合、返されるデータは JSON 形式です。外部システムの場合は、リクエストパラメーターを設定するときに、返されるデータの形式を指定するパラメーターを設定できます。読みやすくするために、サンプルレスポンスはフォーマットされています。実際のレスポンスには、改行やインデントは含まれません。

XML 形式

<?xml version="1.0" encoding="utf-8"?> 
<!--結果ルートノード-->
<Operation name + Response>
    <!--リクエストタグを返す-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--結果データを返す-->
</Operation name + Response>

JSON 形式

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