公用參數 - Database Gateway - Deprecated

公用參數是指所有介面調用都需要用到的參數，包含公用請求參數和公用返回參數。

公用請求參數

名稱	類型	是否必須	描述
Format	String	否	傳回值的類型為JSON格式或XML格式。
Version	String	是	API版本號碼，為日期形式：YYYY-MM-DD，本版本對應的版本號碼為2019-03-27。
AccessKeyId	String	是	阿里雲分配給使用者訪問服務所用的密鑰ID。
Signature	String	是	簽名結果串。關於簽名的計算方法，請參見簽名機制。
Timestamp	String	是	請求的時間戳記。日期格式按照ISO8601標準表示，並需要使用UTC時間，格式為YYYY-MM-DDThh:mm:ssZ。例如，`2013-08-15T12:00:00Z`為北京時間2013年8月15日20點0分0秒。
SignatureVersion	String	是	簽名演算法版本，目前的版本是1.0。
SignatureNonce	String	是	唯一隨機數，用於防止網路重放攻擊。在不同請求間要使用不同的隨機數值。

公用返回參數

使用者發送的每次介面調用請求，無論成功與否，系統都會返回一個唯一識別碼RequestId給使用者。

請求樣本

https://dg.aliyuncs.com/
?Format=xml
&Version=2019-03-27
&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服務後，系統返回的資料採用統一格式。返回2xx的HTTP狀態代碼，表示調用成功；返回4xx或5xx的HTTP狀態代碼，表示調用失敗。調用成功返回的資料格式是JSON格式，外部系統可以在請求時傳入參數來制定返回的資料格式。為了便於查看，本文檔中的返回樣本做了格式化處理，實際返回結果是沒有進行換行、縮排等處理的。

XML格式

<?xml version="1.0" encoding="utf-8"?> 
<!--結果的根結點-->
<介面名稱+Response>
    <!--返回請求標籤-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--返回結果資料-->
</介面名稱+Response>

JSON格式

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* 返回結果資料 */
}