全部產品
Search

搜尋本產品

    Data Management：DescribeRestoreTaskList - 查看恢複工作清單

    文件中心

    Data Management：DescribeRestoreTaskList - 查看恢複工作清單

    更新時間：Apr 24, 2026

    該介面用於查看DBS恢複工作清單。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:DescribeRestoreTaskList

    get

    *BackupPlan

    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    否

    備份計劃 ID。

    說明

    請填入本參數 BackupPlanId 或 RestoreTaskId。

    dbs1hvb0wwwXXXXX
    RestoreTaskId

    string

    否

    恢複任務 ID，支援多個查詢，使用半形逗號（,）分隔。您可以調用 CreateRestoreTask 介面擷取該參數。

    說明

    請填入本參數 RestoreTaskId 或 BackupPlanId，同時填入時會導致報錯。

    s102h7rf5anq
    PageSize

    integer

    否

    每頁的記錄數，取值為 1~100。

    說明

    預設為 30。

    30
    PageNum

    integer

    否

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

    1
    ClientToken

    string

    否

    用於保證請求的等冪性，防止重複提交請求。

    ETnLKlblzczshOTUbOCzxxxxxxx
    StartTimestamp

    integer

    否

    開始備份時間。

    1570701361528
    EndTimestamp

    integer

    否

    結束備份時間。

    1570701361528

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情如下。

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    PageNum

    integer

    頁碼。

    1
    RequestId

    string

    請求 ID。

    9C397502-B4F2-4E22-AD97-C81F0049F3F3
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    boolean

    是否成功。

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    TotalPages

    integer

    總頁數。

    1
    TotalElements

    integer

    總恢複任務數。

    1
    PageSize

    integer

    每頁的記錄數。

    30
    Items

    object

    RestoreTaskDetail

    array<object>

    恢複任務詳情列表

    object

    RestoreStatus

    string

    恢複任務狀態，取值：

    • init：未啟動或預檢查失敗

    • running：運行中

    • stop：失敗

    • pause：暫停

    • check_pass：預檢查通過

    running
    FullStruAfterRestoreProgress

    integer

    全量結構後置恢複進度。

    100
    CrossRoleName

    string

    跨阿里雲帳號備份的 RAM 角色名稱。

    test123
    RestoreDir

    string

    復原路徑。

    /home/test
    CrossAliyunId

    string

    跨阿里雲帳號備份的 UID。

    2xxx7778xxxxxxxxxx
    RestoreObjects

    string

    恢複對象。

    [ { \"DBName\":\"test\" } ]
    BackupPlanId

    string

    備份計劃 ID。

    dbsxxxx
    DestinationEndpointRegion

    string

    恢複目的端執行個體所在地區。

    cn-hangzhou
    RestoreTaskCreateTime

    integer

    恢複任務建立時間（毫秒）。

    1554560477000
    DestinationEndpointUserName

    string

    恢複目的端資料庫帳號。

    testUser
    RestoreTaskFinishTime

    integer

    恢複任務完成時間（毫秒）。

    1554560477000
    DestinationEndpointIpPort

    string

    恢複目的端資料庫執行個體串連地址。

    100.X.X.10:33204
    DestinationEndpointDatabaseName

    string

    恢複目的端資料庫名稱。

    test
    DestinationEndpointInstanceType

    string

    資料庫所在位置，取值：

    • RDS

    • ECS

    • Express：通過專線/VPN 閘道/智能網關接入的資料庫

    • Agent：通過備份網關接入的資料庫

    • DDS：雲 MongoDB

    • Other：通過 IP:Port 直連的資料庫

    • dg：無公網 IP:Port 的自建資料庫（通過資料庫網關 DG 接入）

    RDS
    DestinationEndpointOracleSID

    string

    Oracle SID 名稱。

    說明

    資料庫類型為 Oracle 時，該參數必傳。

    test
    FullStruforeRestoreProgress

    integer

    全量結構前置恢複進度。

    100
    ErrMessage

    string

    錯誤資訊。

    NULL
    RestoreTaskId

    string

    恢複任務 ID。

    1iyixxxxxx
    FullDataRestoreProgress

    integer

    全量資料恢複進度。

    100
    ContinuousRestoreProgress

    integer

    增量日誌恢複進度。

    100
    DestinationEndpointInstanceID

    string

    恢複目的端資料庫執行個體 ID

    rm-bp1p8c2947XXX
    BackupSetId

    string

    恢複所使用的全量備份組 ID。

    urjlfmxxxxx
    BackupGatewayId

    integer

    備份網關 ID。

    324234332
    RestoreTaskName

    string

    恢複任務名稱。

    dbsr1g3xxxx_Restore_Task_1775009514575
    RestoreTime

    integer

    恢復點（毫秒）。

    1554560477000
    DestinationEndpointHost

    string

    恢複目的端資料庫連接地址

    127.0.0.1
    DestinationEndpointPort

    string

    恢複目的端資料庫連接埠

    3306
    DestinationEndpointEnableSsl

    string

    恢複目的端資料庫是否開啟 SSL 安全連線

    true
    BackupGatewayIdentifier

    string

    恢複目的端備份網關唯一標識碼

    TESTGATEWAY
    BackupSourceOssRegion

    string

    備份源 OSS 所在地區

    cn-beijing
    RestoreDestinationMode

    string

    恢複至目的端方式

    EXIST_INSTANCE
    PhysicalFullBackupRecoverProgress

    integer

    物理全量恢複進度。（適用於 MySQL、SqlServer 物理備份）

    100
    PhysicalFullAndIncrementBackupRecoverProgress

    integer

    物理全量增量恢複進度。（適用於 MySQL 物理備份）

    100
    PhysicalIncrementBackupRecoverProgress

    integer

    物理增量恢複進度。（適用於 SqlServer 物理備份）

    100
    PhysicalDatabaseOnlineProgress

    integer

    物理資料庫線上進度。（適用於 SqlServer 物理備份）

    100
    PhysicalBackupRecoverProgress

    integer

    物理備份恢複進度。（適用於 Oracle 物理備份）

    100

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "RestoreTaskDetail": [
      {
        "RestoreStatus": "running",
        "FullStruAfterRestoreProgress": 100,
        "CrossRoleName": "test123",
        "RestoreDir": "/home/test",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[ { \\\"DBName\\\":\\\"test\\\" } ]",
        "BackupPlanId": "dbsxxxx",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "testUser",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 100,
        "ErrMessage": "NULL",
        "RestoreTaskId": "1iyixxxxxx",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "urjlfmxxxxx",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "dbsr1g3xxxx_Restore_Task_1775009514575",
        "RestoreTime": 1554560477000,
        "DestinationEndpointHost": "127.0.0.1",
        "DestinationEndpointPort": "3306",
        "DestinationEndpointEnableSsl": "true",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "BackupSourceOssRegion": "cn-beijing",
        "RestoreDestinationMode": "EXIST_INSTANCE",
        "PhysicalFullBackupRecoverProgress": 100,
        "PhysicalFullAndIncrementBackupRecoverProgress": 100,
        "PhysicalIncrementBackupRecoverProgress": 100,
        "PhysicalDatabaseOnlineProgress": 100,
        "PhysicalBackupRecoverProgress": 100
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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