全部產品
Search

搜尋本產品

    Data Management：DescribeBackupSetDownloadTaskList - 查看備份組下載列表

    文件中心

    Data Management：DescribeBackupSetDownloadTaskList - 查看備份組下載列表

    更新時間：Jan 13, 2026

    該介面用於查看DBS備份組下載列表。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:DescribeBackupSetDownloadTaskList

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    否

    備份計劃 ID，可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

    說明

    BackupPlanId 或 BackupSetDownloadTaskId 任選其一作為請求參數必填項。

    dbsqhnuhyw3****
    BackupSetDownloadTaskId

    string

    否

    備份組下載任務 ID。

    urxgrxt7****
    PageSize

    integer

    否

    每頁的記錄數，取值 30、50、100。

    說明

    預設每頁記錄數為 30。

    30
    PageNum

    integer

    否

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

    1
    ClientToken

    string

    否

    輸入任意值，用於保證請求的等冪性，防止重複提交請求。

    ETnLKlblzczshOTUbOCzXXXXXX

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情資訊。

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    PageNum

    integer

    頁碼。

    0
    RequestId

    string

    請求 ID。

    6DC3D286-E0E6-5988-A558-2184984B****
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    boolean

    請求是否成功，傳回值如下：

    • true：請求成功

    • false：請求失敗

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.
    TotalPages

    integer

    總頁數。

    1
    TotalElements

    integer

    總備份組下載記錄數。

    1
    PageSize

    integer

    每頁的記錄數。

    30
    Items

    object

    BackupSetDownloadTaskDetail

    array<object>

    備份計劃詳情。

    object

    備份計劃詳情。

    BackupSetDownloadStatus

    string

    備份組下載狀態，傳回值如下：

    • checking：預檢查中

    • init：預檢查失敗（未啟動）

    • check_pass：預檢查通過

    • pause：暫停

    • schedule：等待調度

    • running：運行中

    • stop：失敗

    • finish：完成

    finish
    BackupSetDataSize

    integer

    備份組資料大小。

    237837
    BackupSetDownloadTargetType

    string

    備份組下載目標類型。

    說明

    僅自動下載顯示，agent 表示已安裝備份網關。

    無
    BackupSetDownloadDir

    string

    備份組下載伺服器目錄。

    說明

    僅自動下載有值。

    無
    ErrMessage

    string

    異常資訊。

    java.lang.IndexOutOfBoundsException.
    BackupSetDownloadCreateTime

    integer

    建立時間戳記。

    1642044001000
    BackupPlanId

    string

    備份計劃 ID。

    qhnuhyw3****
    BackupSetDbType

    string

    資料庫類型。

    MySQL
    BackupSetDownloadInternetUrl

    string

    備份組公網下載地址。

    說明

    僅手工下載類型，且轉換完成的有值。

    "//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
    BackupSetId

    string

    源備份組 ID。

    1h7za2yws****
    BackupSetDownloadIntranetUrl

    string

    備份組內網下載地址。

    說明

    僅手工下載類型，且轉換完成的有值。

    "//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"
    BackupGatewayId

    integer

    備份組備份網關，僅自動下載有值。

    無
    BackupSetDownloadWay

    string

    下載類型，傳回值如下：

    • manual：手工

    • auto：自動

    manual
    BackupSetDownloadFinishTime

    integer

    完成時間戳記。

    1642044013000
    BackupSetJobType

    string

    源備份組任務類型，傳回值如下：

    • cbs_backup_sub_full：邏輯全量任務

    • cbs_backup_sub_cont：邏輯增量任務

    cbs_backup_sub_cont
    BackupSetDownloadTaskId

    string

    備份組下載任務 ID。

    urxgrxt7****
    BackupSetDownloadTaskName

    string

    備份組下載任務名稱。

    1h7za2yws****-ManualCont
    BackupSetDataFormat

    string

    備份組下載資料格式，取值如下：

    • Native

    • SQL

    • CSV

    • JSON

    Native
    BackupSetCode

    string

    源備份組編碼。

    mysql-bin.00XXXX

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "PageNum": 0,
  "RequestId": "6DC3D286-E0E6-5988-A558-2184984B****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "BackupSetDownloadTaskDetail": [
      {
        "BackupSetDownloadStatus": "finish",
        "BackupSetDataSize": 237837,
        "BackupSetDownloadTargetType": "無",
        "BackupSetDownloadDir": "無",
        "ErrMessage": "java.lang.IndexOutOfBoundsException.",
        "BackupSetDownloadCreateTime": 1642044001000,
        "BackupPlanId": "qhnuhyw3****",
        "BackupSetDbType": "MySQL",
        "BackupSetDownloadInternetUrl": "\"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\"",
        "BackupSetId": "1h7za2yws****",
        "BackupSetDownloadIntranetUrl": "\"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\"",
        "BackupGatewayId": 0,
        "BackupSetDownloadWay": "manual",
        "BackupSetDownloadFinishTime": 1642044013000,
        "BackupSetJobType": "cbs_backup_sub_cont",
        "BackupSetDownloadTaskId": "urxgrxt7****",
        "BackupSetDownloadTaskName": "1h7za2yws****-ManualCont",
        "BackupSetDataFormat": "Native",
        "BackupSetCode": "mysql-bin.00XXXX"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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