全部產品
Search

搜尋本產品

    Cloud Backup：CreateBackupJob - 建立備份任務

    文件中心

    Cloud Backup：CreateBackupJob - 建立備份任務

    更新時間：Dec 23, 2025

    建立一個手動備份任務。

    調試

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

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    JobName

    string

    否

    備份任務名稱。

    k8s-backup-infra-20220131150046-hbr
    SourceType

    string

    是

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

    • UDM_ECS：表示 ECS 整機備份。

    枚舉值：

    • UDM_ECS :

      ECS 整機備份

    UDM_ECS
    Retention

    integer

    否

    備份保留天數。

    15
    InstanceId

    string

    否

    當 SourceType 取值為UDM_ECS時，需要配置該參數。 表示 ECS 執行個體 ID。

    i-bp1xxxxxxxxxxxxxxysm
    Detail

    object

    否

    當 SourceType 取值為UDM_ECS時，需要配置該參數。 類型為 JSON 字串。

    • doCopy：是否開啟異地複寫

    • destinationRegionId：異地複寫目標地區

    • destinationRetention：異地複寫備份點保留時間

    • diskIdList：備份的雲端硬碟 ID 列表，為空白時備份全部雲端硬碟。

    • snapshotGroup：是否使用一致性快照組（僅執行個體所有雲端硬碟均為 ESSD 時有效）。

    • appConsistent：是否使用應用一致性（需要搭配參數 preScriptPath 和 postScriptPath 使用）。

    • preScriptPath：凍結指令碼路徑。

    • postScriptPath：解凍指令碼路徑。

    • enableWriters：僅當 AppConsistent 為 true 時，需要配置該參數。是否設定應用一致性快照（預設為 true）：

      • true：建立應用一致性快照

      • false：建立檔案系統一致性快照

    • enableFsFreeze：僅當 AppConsistent 為 true 時，需要配置該參數。是否在建立應用一致性快照前使用 Linux 的 FsFreeze 機制確保檔案系統處於唯讀一致性。預設為 true。

    • timeoutSeconds：僅當 AppConsistent 為 true 時，需要配置該參數。IO 凍結逾時時間。預設為 30 秒。

    { "doCopy": false, "destinationRegionId": "", "destinationRetention": null, "diskIdList": [], "snapshotGroup": false, "appConsistent": false, "enableWriters": true, "preScriptPath": "", "postScriptPath": "", "enableFsFreeze": true, "timeoutInSeconds": 60 }
    BackupType

    string

    否

    備份類型。當 SourceType 取值為 UDM_ECS 時，需要配置該參數。

    • COMPLETE：全量備份。

    枚舉值：

    • COMPLETE :

      全量備份

    COMPLETE
    VaultId

    string

    否

    備份倉庫 ID。 當 SourceType 取值為 UDM_ECS 時，不需要配置該參數。

    v-000xxxxxxxxxxxxxxy1v
    SpeedLimit

    string

    否

    當 SourceType 取值為UDM_ECS時，該參數不生效。 表示備份流量控制。格式為{start}|{end}|{bandwidth}。多個流量控制配置使用|分隔，並且配置時間不允許有重疊。

    • start：起始小時。

    • end：結束小時。

    • bandwidth：限制速率，單位 KB/s。

    0|24|1024
    Options

    string

    否

    無需填寫。

    {}
    Include

    string

    否

    當 SourceType 取值為UDM_ECS時，該參數不生效。 表示需要備份的路徑，該路徑下所有檔案都備份。最多支援 255 個字元。

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

    string

    否

    當 SourceType 取值為UDM_ECS時，該參數不生效。 表示不需要進行備份的路徑，該路徑下所有檔案都不備份。最多支援 255 個字元。

    ["/var", "/proc"]
    ClusterId

    string

    否

    無需填寫。

    ""
    ContainerResources

    string

    否

    無需填寫。

    ""
    InitiatedByAck

    boolean

    否

    false 或留空

    false
    ContainerClusterId

    string

    否

    無需填寫

    ""
    CrossAccountType

    string

    否

    跨帳號備份類型。支援：

    • SELF_ACCOUNT：本帳號備份

    • CROSS_ACCOUNT：跨帳號備份

    SELF_ACCOUNT
    CrossAccountUserId

    integer

    否

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

    158975xxxxxx4625
    CrossAccountRoleName

    string

    否

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

    BackupRole

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    返回碼，200 表示成功。

    200
    Message

    string

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

    successful
    RequestId

    string

    請求 ID。

    25F49E7B-7E39-542E-83AD-62E6E7F73786
    Success

    boolean

    請求是否成功。

    • true：成功。

    • false：失敗。

    true
    JobId

    string

    備份任務 ID。

    job-000csy09q50a2jdcbwbo

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "25F49E7B-7E39-542E-83AD-62E6E7F73786",
  "Success": true,
  "JobId": "job-000csy09q50a2jdcbwbo"
}

    錯誤碼

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

    變更歷史

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