全部產品
Search

搜尋本產品

    Cloud Backup：CreateBackupPlan - 建立備份計劃

    文件中心

    Cloud Backup：CreateBackupPlan - 建立備份計劃

    更新時間：Mar 27, 2026

    建立一個備份計劃。

    介面說明

    重要

    • 如果您希望使用 ECS 檔案備份基礎版、雲端硬碟備份、容器備份、TableStore 備份免費試用、歸檔、資料同步等功能請調用本介面。

    • 如果您希望使用 NAS 備份/OSS 備份 30 天免費試用，請調用 CreateTrialBackupPlan 介面。

    • 如果您希望使用 ECS 檔案備份/本地檔案備份/ECS 整機備份/NAS 備份/OSS 備份/CPFS 備份標準能力，請調用 CreatePolicyV2+CreatePolicyBindings 介面。

    • 備份計劃關聯了資料來源與備份策略以及其他備份所需的資訊。備份計劃執行後會產生備份任務，記載備份進度與備份結果。如果備份任務成功，會產生一個備份快照。可以使用備份快照建立恢複任務。

    • 一個備份計劃僅支援一個資料來源。

    • 一個備份計劃僅支援單個固定時間間隔的備份周期策略。

    • 一個備份計劃僅能向一個備份倉庫進行備份。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hbr:CreateBackupPlan

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    SourceType

    string

    是

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

    • ECS_FILE：備份 ECS 檔案

    • OSS：備份阿里雲 OSS

    • NAS：備份阿里雲 NAS

    • OTS：備份阿里雲 OTS

    • UDM_ECS：備份 ECS 整機

    • SYNC：資料同步

    ECS_FILE
    PlanName

    string

    否

    備份計劃名稱。1~64 個字元，單個備份倉庫下每一種資料來源類型的備份計劃名稱唯一。

    planname
    BackupType

    string

    否

    備份類型。取值為 COMPLETE，表示全量備份。

    COMPLETE
    VaultId

    string

    否

    備份倉庫 ID。

    v-0006******q
    Schedule

    string

    否

    備份策略。可選格式：I|{startTime}|{interval}。表示從{startTime}開始每隔{interval}的時間執行一次備份任務。不會補償已過去時間的備份任務。如果上一次備份任務沒有完成，不會觸發下一次備份任務。例如I|1631685600|P1D表示從 2021-09-15 14:00:00 開始每隔一天備份一次。

    • startTime：備份起始時間，UNIX 時間，單位秒。

    • interval： ISO8601 時間間隔。例如：PT1H 表示間隔一小時。P1D 表示間隔一天。

    I|1602673264|P1D
    Retention

    integer

    否

    備份保留天數，最小值為 1，單位為天。

    7
    ClusterId

    string

    否

    執行資料同步計劃的用戶端組 ID。（僅同步需要）

    cl-***************
    FileSystemId

    string

    否

    僅當 SourceType 取值為 NAS 時，需要配置該參數。表示檔案系統 ID。

    005494
    CreateTime

    integer

    否

    僅當 SourceType 取值為 NAS 時，需要配置該參數。表示檔案系統建立時間。UNIX 時間，單位為秒。

    1607436917
    Bucket

    string

    否

    僅當 SourceType 取值為 OSS 時，需要配置該參數。表示 OSS bucket 名稱。

    hbr-backup-oss
    Prefix

    string

    否

    僅當 SourceType 取值為 OSS 時，需要配置該參數。表示備份首碼。指定後，僅備份首碼相匹配的對象。

    oss-prefix
    InstanceId

    string

    否

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

    i-m5e*****6q
    Detail

    object

    否

    整機備份詳情，類型為 JSON 字串。

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

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

    • preScriptPath：凍結指令碼路徑。

    • postScriptPath：解凍指令碼路徑。

    {\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
    UdmRegionId

    string

    否

    整機備份執行個體所在地區。

    cn-shanghai
    SpeedLimit

    string

    否

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

    • start：起始小時。

    • end：結束小時。

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

    0:24:5120
    Include

    string

    否

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

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

    string

    否

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

    ["/var", "/proc"]
    Options

    string

    否

    僅當 SourceType 取值為ECS_FILE時，需要配置該參數。表示是否使用 Windows 系統 VSS 定義備份路徑。

    • 此功能僅支援 Windows 類型 ECS 執行個體。

    • 如果備份源中有資料更改，需要確保備份資料與來源資料的一致時，才可配置為["UseVSS":true]。

    • 選擇使用 VSS 後，不支援多個檔案目錄同時備份。

    {"UseVSS":false}
    DataSourceId

    string

    否

    源端資料來源 ID。（僅同步需要）

    ds-****************
    Path

    array

    否

    備份路徑。

    string

    否

    備份路徑。最多 65536 個字元。 備份路徑規則如下：

    • 無萬用字元（*）的情況下，可以輸入 20 行路徑。

    • 使用萬用字元（*）時，只能輸入 1 行路徑，支援形如/*/*的萬用字元。

    • 每行只支援絕對路徑。

    • 使用 VSS 時，不支援多個路徑、UNC 路徑、萬用字元、排除檔案。

    • 使用 UNC 時，不支援 VSS、萬用字元、排除檔案。當備份源包含 UNC 路徑時，將不會對 Windows ACL 進行備份。

    ["/home"]
    Rule

    array<object>

    否

    備份計劃規則。

    object

    否

    備份計劃規則。

    DestinationRetention

    integer

    否

    異地備份保留天數。

    7
    Schedule

    string

    否

    備份策略。可選格式：I|{startTime}|{interval}。表示從{startTime}開始每隔{interval}的時間執行一次備份任務。不會執行已過去時間的備份任務。如果上一次備份任務沒有完成，不會觸發下一次備份任務。例如 I|1631685600|P1D 表示從 2021-09-15 14:00:00 開始每隔一天備份一次。

    startTime：備份起始時間，UNIX 時間，單位為秒。 interval： ISO8601 時間間隔。例如：PT1H 表示間隔一小時。P1D 表示間隔一天。

    I|1602673264|P1D
    Retention

    integer

    否

    備份保留時間。

    7
    Disabled

    boolean

    否

    規則是否生效。

    false
    DoCopy

    boolean

    否

    是否啟用異地複寫。

    false
    DestinationRegionId

    string

    否

    異地複寫地區 ID。

    cn-hangzhou
    RuleName

    string

    否

    規則名稱。

    rule-test-name
    BackupType

    string

    否

    備份類型。

    COMPLETE
    InstanceName

    string

    否

    Table Store執行個體名稱。

    instancename
    OtsDetail OtsDetail

    否

    Table Store執行個體詳情。

    CrossAccountType

    string

    否

    跨帳號備份類型。支援：

    • SELF_ACCOUNT：本帳號備份

    • CROSS_ACCOUNT：跨帳號備份

    枚舉值：

    • SELF_ACCOUNT :

      SELF_ACCOUNT

    • CROSS_ACCOUNT :

      CROSS_ACCOUNT

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    否

    用於跨帳號備份的原帳號 ID。

    15897534xxxx4625
    CrossAccountRoleName

    string

    否

    用於跨帳號備份的原帳號 RAM 中建立的角色名稱。

    BackupRole
    KeepLatestSnapshots

    integer

    否

    是否開啟保留至少一個備份版本。

    • 0 - 不保留

    • 1 - 保留

    枚舉值：

    • 0 :

      不保留

    • 1 :

      保留

    1
    DestSourceType

    string

    否

    目的端資料來源類型。（僅同步需要）

    OSS
    DestDataSourceId

    string

    否

    目的端資料來源 ID。（僅同步需要）

    ds-*********************

    DestDataSourceDetail

    object

    否

    目的端資料來源詳情。（僅同步需要）

    {\"prefix\":\"/\"}
    ChangeListPath

    string

    否

    增量檔案同步列表的配置。（僅同步需要）

    {"dataSourceId": "ds-123456789", "path": "/changelist"}
    Disabled

    boolean

    否

    計劃是否預設禁用

    true
    Edition

    string

    否

    版本類型，支援 BASIC 和 STANDARD，預設值為 STANDARD。

    STANDARD

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料。

    Code

    string

    返回碼，200 表示成功。

    200
    Message

    string

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

    successful
    RequestId

    string

    請求 ID。

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

    string

    備份計劃 ID。

    plan-*********************
    Success

    boolean

    請求是否成功。

    • true：成功。

    • false：失敗。

    true

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

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