全部產品
Search
文件中心

Cloud Backup:UpdatePolicyBinding

更新時間:Jul 30, 2026

修改策略與資料來源的關聯關係。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:UpdatePolicyBinding

update

*全部資源。

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

PolicyId

string

是

策略 ID。

po-000************ky9

DataSourceId

string

是

資料來源 ID。

i-bp1************dtv

SourceType

string

是

資料來源類型。取值範圍:

  • UDM_ECS:表示 ECS 整機備份。

  • OSS:表示 OSS 備份。

  • NAS:表示阿里雲 NAS 備份。

  • COMMON_NAS:表示本地 NAS 備份。

  • ECS_FILE:表示 ECS 檔案備份標準版。

  • File:表示本地檔案備份。

  • COMMON_FILE_SYSTEM:表示 CPFS 備份。

  • OTS:表示 Tablestore 備份。

UDM_ECS

PolicyBindingDescription

string

否

綁定策略描述。

po-000************5xx-i-2ze************nw4

Disabled

boolean

否

策略對該資料來源是否暫停生效。

  • true:暫停

  • false:未暫停

true

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:5120

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 清單檔案產生完成之前可能會備份失敗,可以等待下個週期執行。

30663060

InventoryCleanupPolicy

string

否

備份後是否刪除清單檔案。僅當使用 OSS 清單時有效。支援:

  • NO_CLEANUP:不刪除。

  • DELETE_CURRENT:刪除目前檔案。

  • DELETE_CURRENT_AND_PREVIOUS:刪除所有檔案。

NO_CLEANUP

IgnoreArchiveObject

boolean

否

不在任務統計和失敗檔案清單中提示歸檔型物件。

true

CommonFileSystemDetail

object

否

大規模檔案系統備份詳情。

FullOnIncrementFail

boolean

否

增量備份失敗時是否轉為全量備份。取值:

  • true:失敗時轉為全量備份。

  • false:失敗時不轉為全量備份。

true

FetchSliceSize

integer

否

備份分片大小(檔案數)。

100000

返回參數

名稱

類型

描述

樣本值

object

UpdatePolicyBindingResponse

Success

boolean

請求是否成功。

  • true 表示成功。

  • false 表示失敗。

true

Code

string

返回碼,200 表示成功。

200

Message

string

返回資訊描述,成功一般返回 successful,錯誤時會返回相應錯誤資訊。

successful

RequestId

string

請求 ID。

B6F24C46-54B9-519B-9AB8-A8988D705E67

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "B6F24C46-54B9-519B-9AB8-A8988D705E67"
}

錯誤碼

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

變更歷史

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