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

公用請求參數

公用請求參數是指每個介面都需要使用到的請求參數。

名稱 類型 是否必須 描述
Format String 否 傳回值的類型，支援JSON與XML。預設為JSON。
Version String 是 API版本號碼，為日期形式：YYYY-MM-DD，本版本對應的版本號碼為2014-08-15。
AccessKeyId String 是 阿里雲頒發給使用者的訪問服務所用的密鑰ID。
Signature String 是 簽名結果串。關於簽名的計算方法，請參見簽名機制。
SignatureMethod string 是 簽名方式，目前僅支援HMAC-SHA1。
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://rds.aliyuncs.com/
?Format=xml
&Version=2014-08-15
&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狀態代碼，表示調用失敗。調用成功返回的資料格式主要有XML和JSON兩種，外部系統可以在請求時傳入參數來制定返回的資料格式，預設為XML格式。為了便於查看，本文檔中的返回樣本做了格式化處理，實際返回結果是沒有進行換行、縮排等處理的。

成功結果

XML格式

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

JSON格式

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

錯誤結果

調用介面出錯後，系統將不會返回結果資料。您可以根據用戶端錯誤碼表來定位錯誤原因。

當調用出錯時，HTTP請求會返回一個4xx或5xx的HTTP狀態代碼。返回的訊息體中是具體的錯誤碼及錯誤資訊，還包含一個全域唯一的請求ID（RequestId）和一個您該次請求訪問的網站ID（HostId）。若無法在調用方定位錯誤原因，請聯絡阿里雲客服人員，並提供該HostId和RequestId，以便我們能儘快幫您解決問題。

XML格式

<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>rds.aliyuncs.com</HostId>
   <Code>UnsupportedOperation</Code>
   <Message>The specified action is not supported.</Message>
</Error>

錯誤結果

{
    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "rds.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}