Method: projects.databases.exportDocuments

Xuất bản sao của tất cả hoặc một nhóm nhỏ các tài liệu từ Google Cloud Firestore sang một hệ thống lưu trữ khác, chẳng hạn như Google Cloud Storage. Nội dung cập nhật gần đây đối với tài liệu có thể không được phản ánh trong quá trình xuất. Quá trình xuất sẽ diễn ra ở chế độ nền và bạn có thể giám sát cũng như quản lý tiến trình xuất thông qua tài nguyên Vận hành được tạo. Bạn chỉ có thể sử dụng dữ liệu xuất ra sau khi thực hiện xong thao tác liên kết. Nếu quá trình xuất dữ liệu bị huỷ trước khi hoàn tất, thì có thể để lại một phần dữ liệu trong Google Cloud Storage.

yêu cầu HTTP

POST https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*}:exportDocuments

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
name

string

Cơ sở dữ liệu để xuất. Phải có dạng: projects/{projectId}/databases/{databaseId}.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
Trường
collectionIds[]

string

Những mã nhận dạng bộ sưu tập cần xuất. Không xác định có nghĩa là tất cả các bộ sưu tập.
outputUriPrefix

string

URI đầu ra. Hiện tại, chúng tôi chỉ hỗ trợ các URI của Google Cloud Storage ở dạng: gs://BUCKET_NAME[/NAMESPACE_PATH], trong đó BUCKET_NAME là tên của bộ chứa Google Cloud Storage và NAMESPACE_PATH là một đường dẫn không gian tên không bắt buộc trên Google Cloud Storage. Khi chọn tên, hãy nhớ cân nhắc đến nguyên tắc đặt tên của Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Nếu URI là một bộ chứa (không có đường dẫn không gian tên), thì một tiền tố sẽ được tạo dựa trên thời gian bắt đầu.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của Operation.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Để biết thêm thông tin, hãy xem bài viết Tổng quan về việc xác thực.