創建一個備份計劃。
接口說明
- 備份計劃關聯了數據源與備份策略以及其他備份所需的信息。備份計劃執行后會產生備份任務，記載備份進度與備份結果。如果備份任務成功，會產生一個備份快照。可以使用備份快照創建恢復任務。
- 一個備份計劃僅支持一種數據源。
- 一個備份計劃僅支持單個固定時間間隔的備份周期策略。
- 一個備份計劃僅能向一個備份倉庫進行備份。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| hbr:CreateBackupPlan | create | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SourceType | string | 是 | 數據源類型，取值范圍：
| ECS_FILE |
| PlanName | string | 是 | 備份計劃名稱。1~64 個字符，單個備份倉庫下每一種數據源類型的備份計劃名稱唯一。 | planname |
| BackupType | string | 是 | 備份類型。取值為 COMPLETE，表示全量備份。 | COMPLETE |
| VaultId | string | 否 | 備份倉庫 ID。 | v-0006******q |
| Schedule | string | 是 | 備份策略。可選格式：
| I|1602673264|P1D |
| Retention | long | 是 | 備份保留天數，最小值為 1，單位為天。 | 7 |
| FileSystemId | string | 否 | 僅當 SourceType 取值為 NAS 時，需要配置該參數。表示文件系統 ID。 | 005494 |
| CreateTime | long | 否 | 僅當 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 字符串。
| {\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60} |
| UdmRegionId | string | 否 | 整機備份實例所在地域。 | cn-shanghai |
| SpeedLimit | string | 否 | 僅當 SourceType 取值為ECS_FILE時，需要配置該參數。表示備份流量控制。格式為
| 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 定義備份路徑。
| {"UseVSS":false} |
| Path | array | 否 | 備份路徑。 | |
| string | 否 | 備份路徑。最多 65536 個字符。 備份路徑規則如下：
| ["/home"] | |
| Rule | array<object> | 否 | 備份計劃規則。 | |
| object | 否 | 備份計劃規則。 | ||
| DestinationRetention | long | 否 | 異地備份保留天數。 | 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 | long | 否 | 備份保留時間。 | 7 |
| Disabled | boolean | 否 | 規則是否生效。 | false |
| DoCopy | boolean | 否 | 是否啟用異地復制。 | false |
| DestinationRegionId | string | 否 | 異地復制地域 ID。 | cn-hangzhou |
| RuleName | string | 否 | 規則名稱。 | rule-test-name |
| BackupType | string | 否 | 備份類型。 | COMPLETE |
| InstanceName | string | 否 | 表格存儲實例名稱。 | instancename |
| OtsDetail | OtsDetail | 否 | 表格存儲實例詳情。 | |
| CrossAccountType | string | 否 | 跨賬號備份類型。支持：
| CROSS_ACCOUNT |
| CrossAccountUserId | long | 否 | 用于跨賬號備份的原賬號 ID。 | 15897534xxxx4625 |
| CrossAccountRoleName | string | 否 | 用于跨賬號備份的原賬號 RAM 中創建的角色名。 | BackupRole |
| KeepLatestSnapshots | long | 否 | 是否開啟保留至少一個備份版本。
| 1 |
| DestSourceType | string | 否 | 目的端數據源類型。（僅同步需要） | OSS |
| DestDataSourceId | string | 否 | 目的端數據源 ID。（僅同步需要） | ds-********************* |
| DestDataSourceDetail | object | 否 | 目的端數據源詳情。（僅同步需要） | {\"prefix\":\"/\"} |
| ChangeListPath | string | 否 | 增量文件同步列表的配置。（僅同步需要） | {"dataSourceId": "ds-123456789", "path": "/changelist"} |
| Disabled | boolean | 否 | 計劃是否默認禁用 | true |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PlanId": "plan-*********************",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|