Method: projects.databases.indexes.create

شاخص مشخص شده را ایجاد می کند. وضعیت اولیه یک نمایه جدید ایجاد شده CREATING است. پس از تکمیل google.longrunning.Operation بازگشتی، وضعیت READY خواهد بود. اگر فهرست از قبل وجود داشته باشد، تماس وضعیت ALREADY_EXISTS را برمی‌گرداند.

در حین ایجاد، فرآیند ممکن است منجر به خطا شود، در این صورت ایندکس به حالت ERROR خواهد رفت. این فرآیند را می توان با اصلاح داده هایی که باعث خطا شده اند، حذف ایندکس با delete و سپس ایجاد مجدد ایندکس با create بازیابی کرد.

فهرست هایی با یک فیلد واحد ایجاد نمی شوند.

درخواست HTTP

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes

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

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

مولفه های
parent

string

نام پایگاه داده ای که این شاخص برای آن اعمال می شود. برای مثال: projects/{projectId}/databases/{databaseId}

درخواست بدن

بدنه درخواست شامل نمونه ای از Index است.

بدن پاسخگو

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

محدوده مجوز

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

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

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