ドキュメントの全部または一部を Google Cloud Firestore から Google Cloud Storage などの別のストレージ システムにエクスポートします。ドキュメントの最近の更新はエクスポートに反映されない場合があります。エクスポートはバックグラウンドで行われ、作成されたオペレーション リソースを介して進行状況のモニタリングと管理を行うことができます。エクスポートの出力は、関連するオペレーションの完了後にのみ使用できます。エクスポート オペレーションが完了前にキャンセルされると、Google Cloud Storage に部分的なデータが残る可能性があります。
エクスポートの動作と出力形式について詳しくは、https://cloud.google.com/firestore/docs/manage-data/export-import をご覧ください。
HTTP リクエスト
POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
name |
必須。エクスポートするデータベース。形式は |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "collectionIds": [ string ], "outputUriPrefix": string, "namespaceIds": [ string ], "snapshotTime": string } |
フィールド | |
---|---|
collectionIds[] |
エクスポートするコレクション ID。指定しない場合は、すべてのコレクションになります。 |
outputUriPrefix |
出力 URI。現時点では、 |
namespaceIds[] |
空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースに適しています。 空の文字列要素は、デフォルトの名前空間を表します。これは、データベースのデータがデフォルト以外の名前空間にあるものの、含めたくない場合に使用します。このリスト内の各名前空間は一意である必要があります。 |
snapshotTime |
エクスポートするデータベースのバージョンに対応するタイムスタンプ。タイムスタンプは過去の日付で、分に丸められ、 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
レスポンスの本文
成功した場合、レスポンスの本文には Operation
のインスタンスが含まれます。
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳細については、認証の概要をご覧ください。