全部產品
Search

搜尋本產品

    Data Management：DescribeSandboxBackupSets - 查詢快照列表

    文件中心

    Data Management：DescribeSandboxBackupSets - 查詢快照列表

    更新時間：Apr 21, 2026

    查詢沙箱備份組。

    介面說明

    執行該操作前，您需要先開啟資料庫執行個體的沙箱功能，詳情請參見RDS MySQL 應急恢複或自建 MySQL 應急恢複（沙箱執行個體）。 當前介面僅支援 DBS API 服務 2021-01-01 版本。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:DescribeSandboxBackupSets

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    是

    備份計劃 ID。

    說明

    若您的執行個體為 RDS MySQL，請通過自動添加資料來源功能，將 RDS 自動添加至 DBS 中，即可擷取備份計劃 ID。

    1hxxxx8xxxxxa
    BackupSetId

    string

    否

    備份組 ID。若您傳入該參數，僅返回該備份組的快照資訊；若不傳入該參數，將返回該備份計劃的所有快照資訊。

    1xxxx2xxxxx1e
    PageSize

    string

    否

    每頁的記錄數。取值如下：

    • 30（預設）

    • 50

    • 100

    30
    PageNumber

    string

    否

    頁碼，大於 0 且不超過 Integer 的最大值，預設值為 1。

    1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Data

    string

    參數說明：

    • backupSetTime：快照時間點，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    • backupSetId：備份組 ID。

    • backupSetType：快照類型，Full 表示全量備份組快照、Inc 表示增量備份快照。

    • backupPlanId：備份計劃 ID。

    "Data": { "number": 2, "size": 2, "content": [ { "backupSetTime": "2021-08-28T23:12:31Z", "backupSetId": "Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134", "backupSetType": "Inc", "backupPlanId": "1hxxxx8xxxxxa" }, { "backupSetTime": "2021-08-28T22:42:28Z", "backupSetId": "1hxxxx8xxxxxa_20210829064228", "backupSetType": "FULL", "backupPlanId": "1hxxxx8xxxxxa" } ], "totalElements": 2 },
    RequestId

    string

    請求 ID。

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    string

    是否請求成功。

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.
    Code

    string

    錯誤碼。

    Param.NotFound
    Message

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    樣本

    正常返回樣本

    JSON格式

    {
  "Data": "  \"Data\": {     \"number\": 2,     \"size\": 2,     \"content\": [       {         \"backupSetTime\": \"2021-08-28T23:12:31Z\",         \"backupSetId\": \"Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\",         \"backupSetType\": \"Inc\",         \"backupPlanId\": \"1hxxxx8xxxxxa\"       },       {         \"backupSetTime\": \"2021-08-28T22:42:28Z\",         \"backupSetId\": \"1hxxxx8xxxxxa_20210829064228\",         \"backupSetType\": \"FULL\",         \"backupPlanId\": \"1hxxxx8xxxxxa\"       }     ],     \"totalElements\": 2   },",
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Param.NotFound",
  "Message": "The specified parameter %s value is not valid."
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    403 Request.Forbidden Have no Permissions 當前操作未被授權，請聯絡主帳號在RAM控制台進行授權後再執行操作

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。