Method: projects.databases.exportDocuments

یک کپی از همه یا زیر مجموعه ای از اسناد را از Google Cloud Firestore به سیستم ذخیره سازی دیگری مانند Google Cloud Storage صادر می کند. به‌روزرسانی‌های اخیر اسناد ممکن است در صادرات منعکس نشود. صادرات در پس‌زمینه اتفاق می‌افتد و می‌توان پیشرفت آن را از طریق منبع عملیاتی ایجاد شده کنترل و مدیریت کرد. خروجی یک صادرات فقط زمانی می تواند مورد استفاده قرار گیرد که عملیات مربوطه انجام شود. اگر عملیات صادرات قبل از تکمیل لغو شود، ممکن است داده‌های جزئی در Google Cloud Storage باقی بماند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
name

string

پایگاه داده برای صادرات باید به این شکل باشد: projects/{projectId}/databases/{databaseId} .

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
زمینه های
collectionIds[]

string

کدام شناسه مجموعه را صادر کنیم. نامشخص یعنی همه مجموعه ها.

outputUriPrefix

string

URI خروجی در حال حاضر فقط از URIهای Google Cloud Storage به شکل: gs://BUCKET_NAME[/NAMESPACE_PATH] پشتیبانی می‌کند، که در آن BUCKET_NAME نام سطل Google Cloud Storage و NAMESPACE_PATH یک مسیر فضای نام فضای ذخیره‌سازی ابری Google اختیاری است. هنگام انتخاب نام، حتماً دستورالعمل‌های نام‌گذاری Google Cloud Storage را در نظر بگیرید: https://cloud.google.com/storage/docs/name . اگر URI یک سطل (بدون مسیر فضای نام) باشد، یک پیشوند بر اساس زمان شروع ایجاد می شود.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Operation است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.