使用CreatePolicyV2介面建立備份策略-雲備份-阿里雲

建立一個策略。

介面說明

備份策略記錄了備份所需的資訊。備份策略執行後會產生備份任務，記載備份進度與備份結果。如果備份任務成功，會產生一個備份快照。可以使用備份快照建立恢複任務。

一個備份策略支援多種資料來源，支援 NAS 備份/OSS 備份/ECS 整機備份/ECS 檔案備份/本地檔案備份/TableStore 備份/CPFS 備份。
一個備份策略僅支援單個固定時間間隔的備份周期策略。
一個備份策略僅能向一個備份倉庫進行備份。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:CreatePolicyV2

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PolicyName	string	否	策略名稱稱。	每天本地備份 + 異地備份
PolicyType	string	否	策略類型，支援： STANDARD：通用備份策略，支援備份除 ECS 整機備份以外的資料來源。 UDM_ECS_ONLY：整機備份策略，僅支援備份 ECS 整機。若未指定策略類型，雲備份服務將按照策略規則中是否指定備份庫自動化佈建策略類型：策略規則中指定備份庫：STANDARD 策略規則中未指定備份庫：UDM_ECS_ONLY	STANDARD
PolicyDescription	string	否	策略描述。	每天早上10點備份一次，異地備份到上海。
Rules	array<object>	否	策略規則列表。
	array<object>	否	策略規則。
RuleType	string	是	規則類型，每一個策略需要至少有一個 BACKUP 類型規則，有且僅有一個 TRANSITION 類型規則： BACKUP：備份規則。 TRANSITION：生命週期規則。 REPLICATION：複製規則。 TAG: 標籤關聯資源規則。	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 取值為 BACKUP，TRANSITION 或 REPLICATION 時，需要配置該參數。 RuleType 取值為 BACKUP：備份保留時間，優先順序低於 RuleType=TRANSITION 的規則的 Retention，最小值為 1，最大值為 364635，單位為天。 RuleType 取值為 TRANSITION：備份保留時間，最小值為 1，最大值為 364635，單位為天。 RuleType 取值為 REPLICATION：異地備份保留時間，最小值為 1，最大值為 364635，單位為天。	7
ReplicationRegionId	string	否	僅當 RuleType 取值為 REPLICATION 時，需要配置該參數。複製的目標地區 ID。	cn-shanghai
RetentionRules	array<object>	否	僅當 RuleType 取值為 TRANSITION 時，需要配置該參數。特殊保留規則。
	object	否	特殊保留規則。
AdvancedRetentionType	string	否	特殊保留規則類型： DAILY: 每天的備份 WEEKLY：每周的備份 MONTHLY：每月的備份 YEARLY：每年的備份	YEARLY
WhichSnapshot	integer	否	針對第幾個備份生效，當前僅支援第 1 個備份，值為 1。	1
Retention	integer	否	備份的特殊保留時間，最小值為 1，單位為天。	730
VaultId	string	否	僅當 RuleType 取值為 BACKUP 時，需要配置該參數。備份庫 ID。	v-0001************aseg
KeepLatestSnapshots	integer	否	是否開啟保留至少一個備份版本。 0 - 不保留 1 - 保留	1
Immutable	boolean	否	僅當 PolicyType 為UDM_ECS_ONLY時，該欄位有效。表示是否開啟備份鎖定。	true
DataSourceFilters	array<object>	否	僅當 RuleType 取值為 TAG 時，需要配置該參數。資料來源過濾規則。
	object	否
SourceType	string	否	資料來源類型。取值範圍： UDM_ECS：表示 ECS 整機備份。僅當 PolicyType 取值為UDM_ECS_ONLY時，支援該資料來源類型。 OSS：表示 OSS 備份。僅當 PolicyType 取值為 STANDARD 時，支援該資料來源類型。 NAS：表示阿里雲 NAS 備份。僅當 PolicyType 取值為 STANDARD 時，支援該資料來源類型。 ECS_FILE：表示 ECS 檔案備份。僅當 PolicyType 取值為 STANDARD 時，支援該資料來源類型。 OTS：表示 Tablestore 備份。僅當 PolicyType 取值為 STANDARD 時，支援該資料來源類型。	UDM_ECS
DataSourceIds	array	否	已廢棄。
	string	否	已廢棄。	已廢棄。
TagFilters	array<object>	否	僅當 RuleType 取值為 TAG 時，需要配置該參數。資源標籤過濾規則。
	object	否
Key	string	否	標籤鍵。	env
Value	string	否	標籤值，為空白時表示任意值。	prod
Operator	string	否	標籤匹配規則，支援 EQUAL：匹配標籤鍵和標籤值。 NOT：匹配標籤鍵，不匹配標籤值。	EQUAL

返回參數

名稱	類型	描述	樣本值
	object	CreatePolicyResponse
Success	boolean	請求是否成功。 true：成功 false：失敗	true
Code	string	返回碼。200 表示成功。	200
Message	string	返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。	successful
RequestId	string	請求 ID。	EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F
PolicyId	string	策略 ID。	po-000000zemnuyx2li3y9y

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F",
  "PolicyId": "po-000000zemnuyx2li3y9y"
}

錯誤碼

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

變更歷史

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