PolarDB-X 2.0 API公用參數-雲原生資料庫 PolarDB-阿里雲

本文介紹PolarDB-X每個介面都需要使用的請求參數和返回參數詳情。

公用請求參數

名稱	類型	是否必須	描述
Format	String	否	返回訊息的格式。取值為JSON（預設值）或XML。
Version	String	是	API版本號碼，使用YYYY-MM-DD日期格式，取值為2020-02-02。
AccessKeyId	String	是	訪問服務使用的密鑰ID。
Signature	String	是	簽名結果串。
SignatureMethod	String	是	簽名方式，取值為HMAC-SHA1。
Timestamp	String	是	請求的時間戳記。使用UTC時間按照ISO8601標準，格式為`YYYY-MM-DDThh:mm:ssZ`。例如，北京時間2013年1月10日20點0分0秒，表示為2013-01-10T12:00:00Z。
SignatureVersion	String	是	簽名演算法版本，取值為1.0
SignatureNonce	String	是	唯一隨機數，用於防止網路重放攻擊，不同請求間會使用不同的隨機數值。
ResourceOwnerAccount	String	否	本次API請求訪問到的資源擁有者賬戶，即登入使用者名稱。

公用返回參數

API返回結果採用統一格式，調用成功返回的資料格式有XML和JSON兩種，可以在發送請求時指定返回的資料格式，預設為XML格式。每次介面調用，無論成功與否，系統都會返回一個唯一識別碼RequestId。

返回2xxHTTP狀態代碼表示調用成功。
返回4xx或5xxHTTP狀態代碼表示調用失敗。

公用返回參數樣本如下：

XML格式

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

JSON格式

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