更新一個備份計劃。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
hbr:UpdateBackupPlan | update | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PlanId | string | 是 | 備份計劃 ID。 | plan-20211***735 |
PlanName | string | 否 | 備份計劃名稱。 | planname |
Schedule | string | 否 | 備份策略。可選格式:
| I|1602673264|P1D |
Retention | long | 是 | 備份保留天數,最小值為 1 天。 | 7 |
Prefix | string | 否 | 僅當 SourceType 取值為 OSS 時,需要配置該參數。表示備份前綴。指定后,僅備份前綴相匹配的對象。 | oss-prefix |
VaultId | string | 是 | 備份倉庫 ID。 | v-0006******q |
Detail | object | 否 | 整機備份詳情,類型為 JSON 字符串。
| {\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60} |
SourceType | string | 否 | 數據源類型,取值范圍:
| ECS_FILE |
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} |
UpdatePaths | boolean | 否 | 當備份路徑為空時,是否更新備份路徑。
| 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|1631685600|P1D |
Disabled | boolean | 否 | 策略是否禁用。 | false |
Retention | long | 否 | 備份保留天數,最小值為 1 天。 | 7 |
DoCopy | boolean | 否 | 是否開啟異地復制。 | false |
DestinationRegionId | string | 否 | 異地備份地域 ID。 | cn-shanghai |
RuleName | string | 否 | 策略名稱。 | rule-test-name |
BackupType | string | 否 | 備份類型。取值為 COMPLETE,表示全量備份。 | COMPLETE |
OtsDetail | OtsDetail | 否 | 表格存儲實例詳情。 | |
KeepLatestSnapshots | long | 否 | 是否開啟保留至少一個備份版本。
| 1 |
ChangeListPath | string | 否 | 增量文件同步列表的配置。(僅同步需要) | {"dataSourceId": "ds-123456789", "path": "/changelist"} |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|