全部產品
Search

搜尋本產品

    Cloud Backup：CreateRestoreJob

    文件中心

    Cloud Backup：CreateRestoreJob

    更新時間：Jul 30, 2026

    建立一個還原任務。

    介面說明

    • 根據所選快照與還原目的地，建立還原任務。

    • 目前資料來源類型與還原目的地資料來源類型需要一致。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hbr:CreateRestoreJob

    create

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RestoreType

    string

    是

    還原目的地資料來源類型，取值範圍：

    • ECS_FILE：還原至 ECS 檔案。

    • OSS：還原至阿里雲 OSS。

    • NAS：還原至阿里雲 NAS。

    • COMMON_FILE_SYSTEM：還原至 CPFS。

    • OTS_TABLE：還原至阿里雲 OTS。

    • UDM_ECS_ROLLBACK：還原至阿里雲 ECS 整機。

    ECS_FILE
    VaultId

    string

    否

    備份快照所屬備份儲存庫 ID。

    v-*********************
    SnapshotId

    string

    否

    備份快照 ID。

    s-********************
    SnapshotHash

    string

    否

    備份快照 HASH 值。

    f2fe...
    SourceType

    string

    是

    資料來源類型，取值範圍：

    • ECS_FILE：還原 ECS 檔案。

    • OSS：還原阿里雲 OSS。

    • NAS：還原阿里雲 NAS。

    • COMMON_FILE_SYSTEM：還原至 CPFS。

    • OTS_TABLE：還原至阿里雲 OTS。

    • UDM_ECS：還原至阿里雲 ECS 整機。

    ECS_FILE
    Options

    string

    否

    還原任務參數。

    {\"includes\":[],\"excludes\":[],\"conflictPolicy\":\"OVERWRITE_EXISTING\"}
    TargetFileSystemId

    string

    否

    僅當 RestoreType 取值為 NAS 時，此參數有效。表示還原目的地的檔案系統 ID。

    005494
    TargetCreateTime

    integer

    否

    僅當 RestoreType 取值為 NAS 時，此參數有效。表示還原目的地的檔案系統建立時間。Unix 時間戳記，單位為秒。

    1554347313
    TargetPath

    string

    否

    僅當 RestoreType 取值為 ECS_FILE 時，此參數有效。表示還原目的地的檔案路徑。

    C:\
    TargetBucket

    string

    否

    僅當 RestoreType 取值為 OSS 時，此參數有效。表示還原目的地的 OSS Bucket 名稱。

    hbr-backup-oss
    TargetPrefix

    string

    否

    僅當 RestoreType 取值為 OSS 時，此參數有效。表示還原目的地的物件前置詞。

    hbr
    UdmDetail

    object

    否

    僅當 SourceType 取值為 UDM_ECS 時，此參數有效。表示整機備份詳細資訊。此參數為 JSON 字串，根據 RestoreType 取值不同，此參數需傳入的詳細資訊如下：

    • UDM_ECS_DISK：ECS 雲端硬碟複製。

      • targetInstanceId：string 類型，必填，表示複製出來的雲端硬碟需要掛載的目標 ECS 執行個體 ID。

      • diskCategory：string 類型，必填，表示目標雲端硬碟類型。

      • diskPerformanceLevel：string 類型，當 diskCategory=essd 時，表示雲端硬碟效能等級，支援 PL0、PL1、PL2 和 PL3，預設 PL1。

    • UDM_ECS_DISK_ROLLBACK：ECS 雲端硬碟還原。

      • sourceInstanceId：string 類型，必填，表示來源 ECS 執行個體 ID。

      • foreceRestore：bool 類型，預設值為 false，表示是否強制還原。當 foreceRestore=true 時，如果備份的雲端硬碟已經從原 ECS 執行個體卸載，或掛載到新的 ECS 執行個體，還原任務仍然會進行雲端硬碟還原，請謹慎操作。

      • bootAfterRestore：bool 類型，預設值為 false，表示還原後是否啟動 ECS 執行個體。

    • UDM_ECS：ECS 整機複製。

      • bootAfterRestore：bool 類型，預設值為 false，表示還原後是否啟動 ECS 執行個體。

      • diskCategory：string 類型，必填，表示目標雲端硬碟類型。

      • diskPerformanceLevel：string 類型，當 diskCategory=essd 時，表示雲端硬碟效能等級，支援 PL0、PL1、PL2 和 PL3，預設 PL1。

      • instanceType：string 類型，必填，表示目標 ECS 執行個體規格。

      • restoredNetwork：string 類型，必填，表示目標 ECS 執行個體的虛擬交換器 ID。

      • securityGroup：string 類型，必填，表示目標 ECS 執行個體的安全性群組 ID。

      • restoredName：string 類型，必填，表示目標 ECS 執行個體的執行個體名稱。

      • restoredHostName：string 類型，必填，表示目標 ECS 執行個體的主機名稱。

      • allocatePublicIp：bool 類型，預設值為 false，表示目標 ECS 執行個體是否分配公網 IP。

      • privateIpAddress：string 類型，表示目標 ECS 執行個體的內網 IP，如果未指定，將使用 DHCP 隨機分配。

    • UDM_ECS_ROLLBACK：ECS 整機還原。

      • sourceInstanceId：string 類型，必填，表示來源 ECS 執行個體 ID。

      • forceRestore：bool 類型，預設值為 false，表示是否強制還原。當 foreceRestore=true 時，如果備份的雲端硬碟已經從原 ECS 執行個體卸載，或掛載到新的 ECS 執行個體，還原任務仍然會進行雲端硬碟還原，請謹慎操作。

      • bootAfterRestore：bool 類型，預設值為 false，表示還原後是否啟動 ECS 執行個體。

    {\"sourceInstanceId\":\"i-uf62te6pm3iwsyxyz66q\",\"bootAfterRestore\":false}
    UdmRegionId

    string

    否

    僅當 SourceType 取值為 UDM_ECS 時，此參數有效。表示還原的目標地域。

    cn-shanghai
    TargetInstanceId

    string

    否

    僅當 RestoreType 取值為 ECS_FILE 時，此參數有效。表示還原目的地的 ECS 執行個體 ID。

    i-*********************
    Include

    string

    否

    還原的路徑。該路徑下所有檔案都會被還原。最多 255 個字元。

    ["/home/alice/*.pdf", "/home/bob/*.txt"]
    Exclude

    string

    否

    不進行還原的路徑。該路徑下所有檔案都不會被還原。最多 255 個字元。

    ["/var", "/proc"]
    TargetContainer

    string

    否

    還原的目標容器詳細資訊。

    {\"host\":\"k8s-node1\",\"hostPrefix\":\"/var/lib/kubelet/pods/4acb31fe-8577-40ff-bc8c-eccabd835f73/volumes/kubernetes.io~csi/pvc-b050b00e-ef17-4792-aab1-1642355cf1f4/mount\",\"pvPath\":\"/\"}
    InitiatedByAck

    boolean

    否

    是否由容器服務呼叫。預設為 false。

    false
    TargetContainerClusterId

    string

    否

    還原的目標容器叢集 ID。

    cc-000amjsc7o1h9506oob7
    TargetInstanceName

    string

    否

    還原的目標表格儲存體執行個體名稱。

    instancename
    TargetTableName

    string

    否

    還原的目標表格儲存體的資料表名稱。

    tablename
    TargetTime

    integer

    否

    還原的表格儲存體的時間。UNIX 時間，單位為秒。

    1642496881
    OtsDetail OtsTableRestoreDetail

    否

    表格儲存體執行個體詳細資訊。

    CrossAccountType

    string

    否

    跨帳號備份類型。支援：

    • SELF_ACCOUNT：本帳號備份

    • CROSS_ACCOUNT：跨帳號備份

    SELF_ACCOUNT
    CrossAccountUserId

    integer

    否

    被目前帳號管理的跨帳號備份的原帳號 ID。

    158975xxxxx4625
    CrossAccountRoleName

    string

    否

    被目前帳號管理的跨帳號備份的原帳號 RAM 中建立的角色名稱。

    BackupRole
    FailbackDetail

    object

    否

    還原至本地的詳細資訊。

    {"cpu":4,"extra":"{\"restoreVMNamePrefix\":\"627-\",\"dataCenterName\":\"SDDC-Datacenter\",\"dataStoreId\":\"datastore-50\",\"folderId\":\"group-v49\",\"resourcePoolId\":\"resgroup-46\",\"locationName\":\"vcenter.pc-uf600a******1.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\",\"computeResourceName\":\"SDDC-Datacenter/Default_c-uf600a******\",\"dataStoreName\":\"Default_c-uf600a******/WorkloadDatastore\",\"networkMoReference\":\"DistributedVirtualPortgroup:dvportgroup-1001\",\"useHotAdd\":false}","instanceId":"i-2vc******z","memoryInMB":8192,"serverId":"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01","uefiBoot":false}
    Edition

    string

    否

    雲端備份功能版本，支援：

    • STANDARD：標準版，預設值。

    • BASIC：基礎版。目前僅支援 ECS 檔案備份基礎版。

    STANDARD

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    返回碼，200 表示成功。

    200
    Message

    string

    返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤訊息。

    successful
    RequestId

    string

    請求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Success

    boolean

    請求是否成功。

    • true：成功

    • false：失敗

    true
    RestoreId

    string

    還原任務 ID。

    r-*********************

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "RestoreId": "r-*********************"
}

    錯誤碼

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

    變更歷史

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