バックアップ ポリシーの作成

  • [アーティクル]

バックアップ ポリシーを作成します。

後で定期的なバックアップのために Service Fabric アプリケーション、サービス、またはパーティションに関連付けることができるバックアップ ポリシーを作成します。

Request

Method 要求 URI
POST /BackupRestore/BackupPolicies/$/Create?api-version=6.4&timeout={timeout}&ValidateConnection={ValidateConnection}

パラメーター

名前 Type 必須 場所
api-version string はい クエリ
timeout integer (int64) いいえ クエリ
ValidateConnection boolean いいえ クエリ
BackupPolicyDescription BackupPolicyDescription はい Body

api-version

型: string
必須: はい
既定値:

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

型: integer (int64)
必須: いいえ
既定値:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。

ValidateConnection

型: ブール値
必須: いいえ
既定値:

バックアップ ポリシーを作成または更新する前に、ストレージ接続と資格情報を検証するかどうかを指定します。

BackupPolicyDescription

種類: BackupPolicyDescription
必須: はい

バックアップ ポリシーについて説明します。

応答

HTTP 状態コード 説明 応答スキーマ
201 (作成済み) 操作が成功すると、201 状態コードが返され、新しいバックアップ ポリシーが作成されます。
その他すべての状態コード 詳細なエラー応答。
 FabricError

使用例

Azure をバックアップの場所として使用して時間ベースのバックアップ ポリシーを作成する

この例では、毎日午前 9 時と午後 5 時 (UTC) に 2 回バックアップを実行するバックアップ ポリシーを作成する方法を示します。これは、Azure BLOB ストアをバックアップの場所として使用して、3 か月後に削除されます。

要求

POST http://localhost:19080/BackupRestore/BackupPolicies/$/Create?api-version=6.4
本文
{
  "Name": "DailyAzureBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "TimeBased",
    "ScheduleFrequencyType": "Daily",
    "RunTimes": [
      "0001-01-01T09:00:00Z",
      "0001-01-01T17:00:00Z"
    ]
  },
  "Storage": {
    "StorageKind": "AzureBlobStore",
    "FriendlyName": "Azure_storagesample",
    "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
    "ContainerName": "BackupContainer"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P3M"
  }
}

201 応答

本文

応答本文は空です。

マネージド ID を使用してアクセスされるバックアップの場所として Azure を使用して時間ベースのバックアップ ポリシーを作成する

この例では、毎日午前 9 時と午後 5 時 (UTC) に 2 回バックアップを実行するバックアップ ポリシーを作成する方法を示します。これは、3 か月後に削除され、マネージド ID を使用するバックアップの場所として Azure BLOB ストアが使用されます。

要求

POST http://localhost:19080/BackupRestore/BackupPolicies/$/Create?api-version=6.4
本文
{
  "Name": "DailyAzureMIBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "TimeBased",
    "ScheduleFrequencyType": "Daily",
    "RunTimes": [
      "0001-01-01T09:00:00Z",
      "0001-01-01T17:00:00Z"
    ]
  },
  "Storage": {
    "StorageKind": "ManagedIdentityAzureBlobStore",
    "FriendlyName": "AzureMI_storagesample",
    "BlobServiceUri": "https://managedidentitytest.blob.core.windows.net/",
    "ContainerName": "BackupContainer",
    "ManagedIdentityType": "Cluster"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P3M"
  }
}

201 応答

本文

応答本文は空です。

ファイル共有をバックアップ場所として使用して頻度ベースのバックアップ ポリシーを作成する

この例では、バックアップの場所としてファイル共有を使用して、20 日後に削除される 10 分ごとにバックアップを実行するバックアップ ポリシーを作成する方法を示します。

要求

POST http://localhost:19080/BackupRestore/BackupPolicies/$/Create?api-version=6.4
本文
{
  "Name": "FileShare10MinBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "FrequencyBased",
    "Interval": "PT10M"
  },
  "Storage": {
    "StorageKind": "FileShare",
    "FriendlyName": "FileShare_myshare",
    "Path": "\\\\myshare\\backupshare",
    "PrimaryUserName": "backupaccount",
    "PrimaryPassword": "abcd1234"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P20D"
  }
}

201 応答

本文

応答本文は空です。

バックアップの場所として Dsms Azure を使用して時間ベースのバックアップ ポリシーを作成する

この例では、毎日午前 9 時と午後 5 時 (UTC) に 2 回バックアップを実行するバックアップ ポリシーを作成する方法を示します。このポリシーは、Dsms Azure BLOB ストアをバックアップの場所として使用して、3 か月後に削除されます。

要求

POST http://localhost:19080/BackupRestore/BackupPolicies/$/Create?api-version=6.4
本文
{
  "Name": "SampleDsmsBackupPolicy",
  "AutoRestoreOnDataLoss": false,
  "MaxIncrementalBackups": "3",
  "Schedule": {
    "ScheduleKind": "TimeBased",
    "ScheduleFrequencyType": "Daily",
    "RunTimes": [
      "0001-01-01T09:00:00Z",
      "0001-01-01T17:00:00Z"
    ]
  },
  "Storage": {
    "StorageKind": "DsmsAzureBlobStore",
    "FriendlyName": "DsmsAzure_storagesample",
    "StorageCredentialsSourceLocation": "https://sample-dsms.dsms.core.winows.net/dsms/samplecredentiallocation/storageaccounts/samplestorageac/servicefabricbackup/samplebackup",
    "ContainerName": "BackupContainer"
  },
  "RetentionPolicy": {
    "RetentionPolicyType": "Basic",
    "MinimumNumberOfBackups": "20",
    "RetentionDuration": "P3M"
  }
}

201 応答

本文

応答本文は空です。