Method: projects.databases.exportDocuments

Xuất bản sao của tất cả hoặc một nhóm nhỏ 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 diễn ra trong nền và tiến trình xuất có thể được theo dõi và quản lý thông qua tài nguyên Hoạt động được tạo. Chỉ có thể sử dụng kết quả của dữ liệu xuất sau khi hoàn tất thao tác liên kết. Nếu một hoạt động xuất bị huỷ trước khi hoàn tất, thì thao tác này 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/v1beta2/{name=projects/*/databases/*}:exportDocuments

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

Tham số đường dẫn

Tham 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

Mã bộ sưu tập cần xuất. Chưa xác định có nghĩa là tất cả các bộ sưu tập.
outputUriPrefix

string

URI đầu ra. Hiện chỉ hỗ trợ các URI Google Cloud Storage có 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à đường dẫn không gian tên Google Cloud Storage tuỳ chọn. Khi chọn tên, hãy nhớ cân nhắc các 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ì 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 phiên bản của Operation.

Phạm vi uỷ quyền

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

  • 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ề hoạt động xác thực.