啟用服務備份

發行項
08/05/2023

啟用此 Service Fabric 服務下具狀態資料分割的定期備份。

啟用屬於此 Service Fabric 服務的具狀態資料分割定期備份。每個分割區會根據指定的備份原則描述個別備份。如果服務所屬的應用程式已經啟用備份，則此作業會覆寫用來針對此服務進行定期備份的原則及其分割區 (，除非在分割區層級明確覆寫) 。請注意，目前僅支援以 C# 為基礎的 Reliable Actor 和 Reliable Stateful 服務進行定期備份。

要求

方法	要求 URI
POST	`/Services/{serviceId}/$/EnableBackup?api-version=6.4&timeout={timeout}`

參數

名稱	類型	必要	Location
`serviceId`	字串	是	路徑
`api-version`	字串	是	查詢
`timeout`	整數 (int64)	No	查詢
`EnableBackupDescription`	EnableBackupDescription	是	body

`serviceId`

類型：字串
必要：是

服務的身分識別。此識別碼通常是不含 'fabric:' URI 配置的服務完整名稱。從 6.0 版開始，階層的名稱會以 "~" 字元分隔。例如，如果服務名稱是 "fabric:/myapp/app1/svc1"，那麼在 6.0 以上的版本中，服務識別為 "myapp~app1~svc1"，在舊版中則為 "myapp/app1/svc1"。

`api-version`

類型：字串
必要：是
預設：6.4

API 的版本。這是必要參數，其值必須是 '6.4'。

Service Fabric REST API 版本是以 API 引進或變更的執行時間版本為基礎。 Service Fabric 執行時間支援多個版本的 API。此版本是 API 的最新支援版本。如果傳遞較低的 API 版本，傳回的回應可能會與本規格中所述的回應不同。

此外，執行時間也接受高於最新支援版本的任何版本，最高為目前版本的執行時間。因此，如果最新的 API 版本是 6.0，而執行時間是 6.1，則執行時間將會接受該 API 的版本 6.1。不過，API 的行為會根據記載的 6.0 版本。

`timeout`

類型：整數 (int64)
必要：否
預設：60
InclusiveMaximum： 4294967295
InclusiveMinimum： 1

用來執行作業的伺服器逾時 (以秒為單位)。此逾時指定了用戶端願意等候要求作業完成的持續時間。這個參數的預設值是 60 秒。

`EnableBackupDescription`

類型： EnableBackupDescription
必要：是

指定啟用備份的參數。

回應

HTTP 狀態碼	描述	回應結構描述
202 (已接受)	202 狀態碼表示已接受啟用服務備份的要求。
所有其他狀態碼	詳細的錯誤回應。	FabricError

範例