全部產品
Search

搜尋本產品

    ApsaraDB for MongoDB：公用參數

    文件中心

    ApsaraDB for MongoDB：公用參數

    更新時間：Feb 28, 2024

    公用請求參數

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

    相關參數說明

    名稱類型是否必須描述
    FormatString是傳回值的類型支援JSON與XML，預設為XML。
    VersionString是API版本號碼，格式為日期形式：YYYY-MM-DD，本版本對應版本號碼為2015-12-01。
    AccessKeyIdString是阿里雲頒發給使用者訪問服務所用的密鑰ID。
    SignatureString是簽名結果串。
    SignatureMethodString是簽名方式，目前支援HMAC-SHA1。
    TimestampString是
    • 請求的時間戳記。日期格式按照ISO8601標準表示，需要使用UTC時間。
    • 格式為：YYYY-MM-DDThh:mm:ssZ，例如：2016-01-01T12:00:00Z（為北京時間2016年1月1日20點0分0秒）。
    SignatureVersionString是簽名演算法版本，目前版本是1.0版本。
    SignatureNonceString是唯一隨機數，用於防止網路重放攻擊。使用者在不同請求間要使用不同的隨機數值。

    請求樣本

    https:// mongodb.aliyuncs.com/?Action=<API Name>
?Format=json
&Version=2015-12-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2016-01-01T12:00:00Z

    公用返回參數

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

    返回樣本

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

    返回結果

    調用API服務後返回資料採用統一格式：
    • 返回的HTTP狀態代碼為2xx，代表調用成功；
    • 返回4xx或5xx的HTTP狀態代碼代表調用失敗。
    調用成功返回的資料格式主要有XML和JSON兩種，外部系統可以在請求時傳入參數來制定返回的資料格式，預設為XML格式。
    說明 本文檔中的返回樣本為了便於使用者查看，做了格式化處理，實際返回結果是沒有進行換行、縮排等處理的。

    返回成功結果

    XML樣本

    返回結果包括請求是否成功等資訊以及具體的業務資料，樣本如下：

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

    JSON樣本

    {
"RequestId": "4C4fdsf38-3910-447D-87AD-AC078932216",
/* 返回結果資料 */
}

    返回錯誤結果

    調用介面出錯後，將不會返回結果資料。調用方可根據錯誤碼表來定位錯誤原因。當調用出錯時，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> mongodb.aliyuncs.com</HostId>
<Code>UnsupportedOperation</Code>
<Message>The specified action is not supported.</Message>
</Error>

    JSON樣本

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