全部產品
Search

搜尋本產品

    Data Management：CreateRestoreTask - 建立恢複任務

    文件中心

    Data Management：CreateRestoreTask - 建立恢複任務

    更新時間：Apr 25, 2026

    該介面用於建立DBS恢複任務。

    介面說明

    相關操作文檔

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dbs:CreateRestoreTask

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BackupPlanId

    string

    是

    備份計劃 ID。

    dbs1hvb0ww****
    DestinationEndpointInstanceType

    string

    是

    資料庫所在位置，取值：

    • RDS

    • ECS

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

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

    • DDS：雲 MongoDB

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

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

    RDS
    DestinationEndpointRegion

    string

    否

    資料庫執行個體的地區。

    說明

    DestinationEndpointInstanceType 為 RDS、ECS、DDS、Express、Agent 時，該參數必傳。

    cn-hangzhou
    DestinationEndpointInstanceID

    string

    否

    資料庫執行個體 ID。

    說明

    DestinationEndpointInstanceType 為 RDS、ECS、DDS、Express 時，該參數必傳。

    rm-bp1p8c29*****
    DestinationEndpointIP

    string

    否

    資料庫連接地址。

    說明

    DestinationEndpointInstanceType 為 express、agent、other，該參數必傳。

    rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com
    DestinationEndpointPort

    integer

    否

    資料庫連接埠。

    說明

    DestinationEndpointInstanceType 為 express、agent、other、ECS，該參數必傳。

    3306
    DestinationEndpointDatabaseName

    string

    否

    資料庫名稱。

    說明

    資料庫類型為 PostgreSQL、MongoDB 時，該參數必傳。

    test
    DestinationEndpointUserName

    string

    否

    資料庫帳號。

    說明

    資料庫類型為 Redis，或者資料庫所在位置為 agent 且資料庫類型為 MSSQL 時該參數非必須，其他情境均必傳。

    test
    DestinationEndpointPassword

    string

    否

    密碼。

    說明

    資料庫類型為 Redis，或者資料庫所在位置為 agent 且資料庫類型為 MSSQL 時該參數非必須，其他情境均必傳。

    Test
    BackupGatewayId

    integer

    否

    備份網關 ID。

    說明

    DestinationEndpointInstanceType 為 agent 時，該參數必傳。

    4312****
    RestoreObjects

    string

    否

    恢複對象。

    • 詳情請參見下面的 RestoreObjects 參數定義，當資料庫所在位置為 agent 時，該參數非必須，其他情境均必傳。

    • 傳入模板：[{ "DBName": "待恢複庫名", "NewDBName": "目標待恢複庫名" }]

    說明

    使用本 API 介面恢複對象僅支援恢複到資料庫層級，如需配置指定表的恢複，請前往控制台進行操作。具體請參見恢複資料庫。

    MySQL表層級恢複樣本如下： [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}]
    RestoreTime

    integer

    否

    恢復，取值：1554560477000。

    1554560477000
    BackupSetId

    string

    否

    恢複所使用的全量備份組 ID，和 RestoreTime 互斥。

    dbs1hvb0w*****
    RestoreTaskName

    string

    是

    恢複任務名稱。

    test
    DestinationEndpointOracleSID

    string

    否

    Oracle SID 名稱。

    說明

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

    test
    RestoreDir

    string

    否

    DestinationEndpointInstanceType 為 agent 且備份計劃為 MySQL 時必傳。

    test
    RestoreHome

    string

    否

    資料庫程式目錄。

    test
    DuplicateConflict

    string

    否

    同名對象衝突處理方式，當前支援：

    renamenew：遇到同名對象則重新命名

    renamenew
    CrossAliyunId

    string

    否

    跨阿里雲帳號備份的 UID。

    2749528728********
    CrossRoleName

    string

    否

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

    test123
    ClientToken

    string

    否

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

    ETnLKlblzczshOTUbOC********
    RestoreDestinationMode

    string

    否

    恢複至目的端方式

    • EXIST_INSTANCE：恢複到已有執行個體

    • NEW_INSTANCE：恢複到建立執行個體

    EXIST_INSTANCE
    EnableDestinationEndpointSsl

    boolean

    否

    是否通過 SSL 安全加密串連目的端

    true
    SslCaPem

    string

    否

    目的端 SSL 安全加密串連憑證

    -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
    DestDatabaseInstanceType

    string

    否

    恢複建立資料庫執行個體類型

    rds
    DestDatabaseInstanceRegion

    string

    否

    恢複建立資料庫執行個體地區

    cn-beijing
    DestDatabaseInstanceVpc

    string

    否

    恢複建立資料庫專用網路

    vpc-xx
    DestDatabaseInstanceClass

    string

    否

    恢複建立資料庫執行個體規格

    mysql.x4.large.2
    DestDatabaseInstanceStorageSize

    string

    否

    恢複建立資料庫執行個體儲存大小

    500
    DestDatabaseInstanceVSwitch

    string

    否

    恢複建立資料庫執行個體交換器

    vsw-xx
    DestDatabaseInstanceDatabaseVersion

    string

    否

    恢複建立資料庫執行個體資料庫版本

    8.0
    AutoOpenDatabase

    string

    否

    Oracle 物理備份恢複是否自動啟動執行個體

    true
    AutoShutdownDatabase

    string

    否

    Oracle 物理備份恢複是否自動關閉執行個體

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數詳情如下。

    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    RequestId

    string

    請求 ID。

    60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC
    ErrCode

    string

    錯誤碼。

    Param.NotFound
    Success

    boolean

    是否成功。

    true
    ErrMessage

    string

    錯誤資訊。

    The specified parameter %s value is not valid.

    RestoreTaskId

    string

    恢複任務 ID。

    s102h*****

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpStatusCode": 200,
  "RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "RestoreTaskId": "s102h*****"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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