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.

Để biết thêm thông tin chi tiết về hành vi xuất và định dạng đầu ra, hãy tham khảo: https://cloud.google.com/firestore/docs/manage-data/export-import

Yêu cầu HTTP

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

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

Tham số đường dẫn

Tham số
name

string

Bắt buộc. 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,
  "namespaceIds": [
    string
  ],
  "snapshotTime": 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.
namespaceIds[]

string

Danh sách trống đại diện cho tất cả các không gian tên. Đây là cách sử dụng ưu tiên cho những cơ sở dữ liệu không sử dụng không gian tên.

Một phần tử chuỗi trống đại diện cho không gian tên mặc định. Bạn nên dùng cách này nếu không muốn đưa dữ liệu vào không gian tên mặc định của cơ sở dữ liệu. Mỗi không gian tên trong danh sách này phải là duy nhất.
snapshotTime

string (Timestamp format)

Dấu thời gian tương ứng với phiên bản cơ sở dữ liệu sẽ được xuất. Dấu thời gian phải ở trong quá khứ, được làm tròn đến phút và không quá earliestVersionTime. Nếu được chỉ định, các tài liệu đã xuất sẽ thể hiện chế độ xem nhất quán của cơ sở dữ liệu tại thời điểm được cung cấp. Nếu không, sẽ không có gì đảm bảo về tính nhất quán của các tài liệu đã xuất.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

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.