調用UpdatePolicyV2 API修改備份策略-雲備份-阿里雲 - Cloud Backup

修改一個策略。

介面說明

策略的修改，將對所有綁定的資料來源生效，請謹慎操作。

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
PolicyId	string	否	策略 ID。	po-000************viy
PolicyName	string	否	策略名稱。	每天備份 + 異地備份
PolicyDescription	string	否	策略描述。	每天早上10點備份一次，異地備份到上海
Rules	array<object>	否	策略規則清單。
	array<object>	否	策略規則。
RuleId	string	否	規則 ID。	rule-000************rof
RuleType	string	否	規則類型，每一個策略需要至少有一個 BACKUP 類型規則，有且僅有一個 TRANSITION 類型規則： BACKUP：備份規則。 TRANSITION：生命週期規則。 REPLICATION：複製規則。	BACKUP
Schedule	string	否	僅當 RuleType 取值為 BACKUP 時，需要設定該參數。備份定時設定。可選格式： `I\|{startTime}\|{interval}`：表示從 {startTime} 開始每隔 {interval} 的時間執行一次備份任務。例如 `I\|1631685600\|P1D` 表示從 2021-09-15 14:00:00 開始每隔一天備份一次。 startTime：備份起始時間，UNIX 時間，單位為秒。 interval：ISO8601 時間間隔。例如：`PT1H` 表示間隔一小時。`P1D` 表示間隔一天。 `C\|{startTime}\|{crontab}`：表示從 {startTime} 開始根據 {crontab} 表達式執行備份任務。例如 `C\|1631685600\|0 0 2 ? * 3,5,7` 表示從 2021-09-15 14:00:00 開始每週二、週四和週六的 02:00:00 執行備份。 startTime：備份起始時間，UNIX 時間，單位為秒。 crontab：crontab 表達式。例如：`0 0 2 ? * 3,5,7` 表示每週二、週四和週六的 02:00:00。不會補償已過去時間的備份任務。如果上一次備份任務沒有完成，不會觸發下一次備份任務。	I\|1648647166\|P1D
BackupType	string	否	僅當 RuleType 取值為 BACKUP 時，需要設定該參數。備份類型。取值為 COMPLETE，表示全量備份。	COMPLETE
Retention	integer	否	僅當 RuleType 取值為 TRANSITION 或 REPLICATION 時，需要設定該參數。 RuleType 取值為 TRANSITION：備份保留時間，最小值為 1，單位為天。 RuleType 取值為 REPLICATION：異地備份保留時間，最小值為 1，單位為天。	7
ReplicationRegionId	string	否	僅當 RuleType 取值為 REPLICATION 時，需要設定該參數。複製的目標地域 ID。	cn-shanghai
ArchiveDays	integer	否	僅當 RuleType 取值為 TRANSITION 時，需要設定該參數。備份轉為歸檔的時間，單位為天。	90
ColdArchiveDays	integer	否	僅當 RuleType 取值為 TRANSITION 時，需要設定該參數。備份轉為冷歸檔的時間，單位為天。	365
VaultId	string	否	僅當 RuleType 取值為 BACKUP 時，需要設定該參數。備份庫 ID。	v-0001************aseg
RetentionRules	array<object>	否	僅當 RuleType 取值為 TRANSITION 時，需要設定該參數。特殊保留規則。
	object	否	特殊保留規則。
AdvancedRetentionType	string	否	特殊保留規則類型： WEEKLY：每週的備份 MONTHLY：每月的備份 YEARLY：每年的備份	YEARLY
WhichSnapshot	integer	否	針對第幾個備份生效，目前僅支援第 1 個備份，值為 1。	1
Retention	integer	否	備份的特殊保留時間，最小值為 1，單位為天。	365
KeepLatestSnapshots	integer	否	是否開啟保留至少一個備份版本。 0 - 不保留 1 - 保留	1
DataSourceFilters	array<object>	否	僅當 RuleType 取值為 TAG 時，需要設定該參數。資料來源篩選規則。
	object	否
SourceType	string	否	資料來源類型。取值範圍： UDM_ECS：表示 ECS 整機備份。僅當 RuleType 取值為 UDM_ECS_ONLY 時，支援該資料來源類型。 OSS：表示 OSS 備份。僅當 RuleType 取值為 STANDARD 時，支援該資料來源類型。 NAS：表示阿里雲 NAS 備份。僅當 RuleType 取值為 STANDARD 時，支援該資料來源類型。 ECS_FILE：表示 ECS 檔案備份標準版。僅當 RuleType 取值為 STANDARD 時，支援該資料來源類型。 OTS：表示 Tablestore 備份。僅當 RuleType 取值為 STANDARD 時，支援該資料來源類型。	UDM_ECS
DataSourceIds `deprecated`	array	否	已廢棄。
`deprecated`	string	否	已廢棄。	已廢棄
TagFilters	array<object>	否	僅當 RuleType 取值為 TAG 時，需要設定該參數。資源標籤篩選規則。
	object	否
Key	string	否	標籤鍵。	env
Value	string	否	標籤值，為空時表示任意值。	prod
Operator	string	否	標籤比對規則，支援 EQUAL：比對標籤鍵和標籤值。 NOT：比對標籤鍵，不比對標籤值。	EQUAL
Immutable	boolean	否	僅當 PolicyType 取值為 UDM_ECS_ONLY 並且 RuleType 取值為 SECURITY 時，需要設定該參數。表示是否開啟備份鎖定。	true

返回參數

名稱	類型	描述	樣本值
	object	UpdatePolicyResponse
Success	boolean	請求是否成功。 true：成功。 false：失敗。	true
Code	string	返回碼，200 表示成功。	200
Message	string	返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。	successful
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

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