Enable Service Backup

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.2-preview&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.2-preview

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


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

Enable service backup

This example shows how to enable periodic backup for a stateful service.

Request

POST http://localhost:19080/Services/CalcApp/CalcService/$/EnableBackup?api-version=6.2-preview
Body
{
  "BackupPolicyName": "DailyAzureBackupPolicy"
}

202 Response

Body

The response body is empty.