Enable Service Backup

Article
04/13/2021

Enables periodic backup of stateful partitions under this Service Fabric service.

Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level). Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.

Request

Method	Request URI
POST	`/Services/{serviceId}/$/EnableBackup?api-version=6.4&timeout={timeout}`

Parameters

Name	Type	Required	Location
`serviceId`	string	Yes	Path
`api-version`	string	Yes	Query
`timeout`	integer (int64)	No	Query
`EnableBackupDescription`	EnableBackupDescription	Yes	Body

`serviceId`

Type: string
Required: Yes

The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.

`api-version`

Type: string
Required: Yes
Default: 6.4

The version of the API. This parameter is required and its value must be '6.4'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

`timeout`

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

`EnableBackupDescription`

Type: EnableBackupDescription
Required: Yes

Specifies the parameters for enabling backup.

Responses

HTTP Status Code	Description	Response Schema
202 (Accepted)	A 202 status code indicates the request to enable service backup has been accepted.
All other status codes	The detailed error response.	FabricError

Examples