調用CreatePolicyBindings API將資料來源綁定到備份策略-雲備份-阿里雲

將一個或多個資料來源綁定到某個策略。

介面說明

每次調用僅支援將相同類型的資料來源綁定到同一個策略。
ECS 整機僅支援綁定到一個策略。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:CreatePolicyBindings

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PolicyId	string	否	策略 ID。	po-000************8ep
PolicyBindingList	array<object>	否	策略繫結資料行表。
	array<object>	否	策略綁定詳情。
PolicyBindingDescription	string	否	策略綁定描述。	這是一個策略綁定的描述。
DataSourceId	string	否	資料來源 ID，根據 SourceType 欄位表示不同含義： UDM_ECS：ECS 執行個體 ID。 OSS：OSS bucket 名稱。 NAS：阿里雲 NAS 檔案系統 ID。 COMMON_NAS：本地 NAS 執行個體 ID。 ECS_FILE：ECS 執行個體 ID。 File：雲備份用戶端識別碼。 COMMON_FILE_SYSTEM：CPFS 備份資料來源 ID。	i-bp1************dl8
Disabled	string	否	策略對該資料來源是否暫停生效。 true：暫停 false：未暫停	true
SourceType	string	否	資料來源類型。取值範圍： UDM_ECS：表示 ECS 整機備份。 OSS：表示 OSS 備份。 NAS：表示阿里雲 NAS 備份。 COMMON_NAS：表示本地 NAS 備份。 ECS_FILE：表示 ECS 檔案備份。 File：表示本地檔案備份。 COMMON_FILE_SYSTEM：表示 CPFS 備份。 OTS: 表示 Tablestore 備份。	UDM_ECS
Source	string	否	根據 SourceType 取值表示不同的含義，SourceType 為 OSS：表示備份某個 prefix，如果不指定，則表示備份整個 Bucket 根目錄，僅支援單個 prefix。如果要備份/backup，則填寫/backup ECS_FILE：表示備份的檔案目錄，如果不指定，則表示備份全部目錄，支援同時指定多個目錄。如果要備份路徑/a 和路徑/b 下的檔案，則填寫["/a", "/b"]。 File：表示備份的檔案目錄，如果不指定，則表示備份全部目錄，支援同時指定多個目錄。如果要備份/a 目錄和/b 目錄下的檔案，則填寫["/a", "/b"]。 COMMON_FILE_SYSTEM：必填，表示備份路徑，支援同時指定多個路徑。如果要備份/a 路徑和/b 路徑，則填寫["/a", "/b"]，如果要備份根路徑則填寫["/"]。 COMMON_NAS：必填，表示備份路徑，僅支援單個路徑。如果要備份/a 路徑則填寫["/a"]，如果要備份根路徑則填寫["/"] OTS：表示備份的資料表列表，如果不指定，則表示備份全部資料表。支援同時指定多個資料表。如果要備份資料表 a 和資料表 b，則填寫["a", "b"]。	backup/
Include	string	否	當 SourceType 取值為ECS_FILE、File、NAS、COMMON_NAS、COMMON_FILE_SYSTEM時，可以配置該參數。表示要進行備份的檔案類型，這些類型的所有檔案都備份。最多支援 255 個字元。	[\".doc\",\".xltm\"]
Exclude	string	否	當 SourceType 取值為ECS_FILE、File、NAS、COMMON_NAS、COMMON_FILE_SYSTEM時，可以配置該參數。表示不需要進行備份的檔案類型，該類型的所有檔案都不備份。最多支援 255 個字元。	[\".doc\",\".xltm\"]
SpeedLimit	string	否	僅當 SourceType 取值為ECS_FILE或 File 時，需要配置該參數。表示備份流量控制。格式為`{start}{end}{bandwidth}`。多個流量控制配置使用分隔，並且配置時間不允許有重疊。 start：起始小時。 end：結束小時。 bandwidth：限制速率，單位 KB/s。	0:24:1024
AdvancedOptions	object	否	進階選項。
UdmDetail	object	否	ECS 整機備份進階選項。
ExcludeDiskIdList	array	否	不需要保護的雲端硬碟 ID 列表。當 DiskIdList 不為空白時，將忽略該參數。
	string	否	無需保護的雲端硬碟 ID。	d-bp1************apo
DiskIdList	array	否	需要保護的雲端硬碟 ID 列表。保護所有雲端硬碟時，該值為空白。
	string	否	需要保護的雲端硬碟 ID。	d-bp1************apo
SnapshotGroup	boolean	否	是否建立快照一致性組。僅雲端硬碟類型全部為 ESSD 時，支援建立快照一致性組。	true
AppConsistent	boolean	否	是否建立應用一致性。僅雲端硬碟類型全部為 ESSD 時，支援建立快照應用一致性。	false
RamRoleName	string	否	僅當 AppConsistent 為 true 時，需要配置該參數。建立應用一致性快照需要配置的 RAM 角色名稱。	AliyunECSInstanceForHbrRole
PreScriptPath	string	否	僅當 AppConsistent 為 true 時，需要配置該參數。建立應用一致性快照前執行的凍結指令碼路徑。	/tmp/prescript.sh
PostScriptPath	string	否	僅當 AppConsistent 為 true 時，需要配置該參數。建立應用一致性快照後執行的解凍指令碼路徑。	/tmp/postscript.sh
EnableFsFreeze	boolean	否	僅當 AppConsistent 為 true 時，需要配置該參數。是否在建立應用一致性快照前使用 Linux 的 FsFreeze 機制確保檔案系統處於唯讀一致性。預設為 true。	true
TimeoutInSeconds	integer	否	僅當 AppConsistent 為 true 時，需要配置該參數。IO 凍結逾時時間。預設為 30 秒。	30
EnableWriters	boolean	否	僅當 AppConsistent 為 true 時，需要配置該參數。是否設定應用一致性快照： true：建立應用一致性快照 false：建立檔案系統一致性快照預設為 true。	true
OssDetail	object	否	OSS 備份進階選項。
InventoryId	string	否	OSS 清單名稱，該值不為空白時將使用 OSS 清單用於效能調優。建議備份 1 億以上 OSS 對象採用清單提升增量效能，由資訊清單檔產生的儲存費用由 OSS 服務單獨收取。 OSS 資訊清單檔產生需要時間，在 OSS 資訊清單檔產生完成之前可能會備份失敗，可以等待下個周期執行。	oss-inventory-default
InventoryCleanupPolicy	string	否	備份後是否刪除資訊清單檔。僅當使用 OSS 清單時有效。支援： NO_CLEANUP：不刪除。 DELETE_CURRENT：刪除當前檔案。 DELETE_CURRENT_AND_PREVIOUS：刪除所有檔案。	NO_CLEANUP
IgnoreArchiveObject	boolean	否	不在任務統計和失敗檔案清單中提示歸檔型對象	true
FileDetail	object	否	檔案備份進階選項。
UseVSS	boolean	否	是否啟用 VSS（Windows）功能。取值： true：啟用。 false：不啟用。	true
AdvPolicy	boolean	否	是否使用進階策略。取值： true：使用。 false：不適用。	true
CommonNasDetail	object	否	本地 NAS 備份進階選項。
FullOnIncrementFail	boolean	否	增量備份失敗時是否轉為全量備份。取值： true：失敗時轉為全量備份。 false：失敗時不轉為全量備份。	true
FetchSliceSize	integer	否	備份分區大小（檔案數）。	100000
ClusterId	string	否	備份用戶端組 ID。本地 NAS 備份將從備份用戶端組中挑選用戶端進行備份。	cl-000**************ggu
CommonFileSystemDetail	object	否	CPFS 備份進階選項。
FullOnIncrementFail	boolean	否	增量備份失敗時是否轉為全量備份。取值： true：失敗時轉為全量備份。 false：失敗時不轉為全量備份。	true
FetchSliceSize	integer	否	備份分區大小（檔案數）。	100000
CrossAccountType	string	否	跨帳號備份類型，預設值為 SELF_ACCOUNT。支援： SELF_ACCOUNT：本帳號備份。 CROSS_ACCOUNT：跨帳號備份。	SELF_ACCOUNT
CrossAccountUserId	integer	否	用於跨帳號備份的原帳號阿里雲 UID。	144**********732
CrossAccountRoleName	string	否	用於跨帳號備份的原帳號 RAM 中建立的角色名稱。	hbrcrossrole

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
Success	boolean	請求是否成功。 true：成功 false：失敗	true
Code	string	返回碼，200 表示成功。	200
Message	string	返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。	successful
RequestId	string	請求 ID。	82CC5B6C-72F7-5D39-92F6-67887DF9AD46

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "82CC5B6C-72F7-5D39-92F6-67887DF9AD46"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	PolicyAlreadyBoundWithThisDataSource	This datasource has already been bound with the policy, please use another one.	資料來源已綁定該策略，請嘗試使用新的策略進行綁定。

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

變更歷史

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