バックアップパーティション

[アーティクル]
07/19/2023

パーティションの状態のバックアップをトリガーします。

ステートフル永続化パーティションの状態のバックアップを作成します。パーティションが既に定期的にバックアップされている場合、既定では新しいバックアップが同じバックアップストレージに作成されます。また、要求本文の一部としてバックアップストレージの詳細を指定することで、同じものをオーバーライドすることもできます。バックアップが開始されると、GetBackupProgress 操作を使用してその進行状況を追跡できます。操作がタイムアウトした場合は、クエリパラメーターにバックアップタイムアウト値を大きく指定します。

Request

Method	要求 URI
POST	`/Partitions/{partitionId}/$/Backup?BackupTimeout={BackupTimeout}&api-version=6.4&timeout={timeout}`

パラメーター

名前	Type	必須	場所
`partitionId`	string (UUID)	はい	パス
`BackupTimeout`	整数 (integer)	いいえ	クエリ
`api-version`	string	はい	クエリ
`timeout`	integer (int64)	いいえ	クエリ
`BackupPartitionDescription`	BackupPartitionDescription	いいえ	本文

`partitionId`

型: string (uuid)
必須: はい

パーティションの ID。

`BackupTimeout`

型: 整数
必須: いいえ
既定値:

バックアップ操作が完了するまで待機する最大時間を分単位で指定します。その後、操作はタイムアウトエラーで完了します。ただし、特定のコーナーケースでは、操作はタイムアウトを返しますが、実際にはバックアップが実行される可能性があります。タイムアウトエラーが発生した場合は、より大きなタイムアウト値でこの操作を再度呼び出すようにすることをお勧めします。同じの既定値は 10 分です。

`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 秒です。

`BackupPartitionDescription`

種類: BackupPartitionDescription
必須: いいえ

パーティションを今すぐバックアップするパラメーターについて説明します。存在しない場合、バックアップ操作では、このパーティションに関連付けられている現在のバックアップポリシーの既定のパラメーターが使用されます。

応答

HTTP 状態コード	説明	応答スキーマ
202 (承認済み)	202 状態コードは、操作要求が受け入れられ、バックアップが開始されることを示します。 GetPartitionBackupProgress 操作を使用して、バックアップ操作の状態を取得します。
その他のすべての状態コード	詳細なエラー応答。	FabricError

使用例