Method: projects.databases.collectionGroups.indexes.list

فهرست های ترکیبی را فهرست می کند.

درخواست HTTP

GET https://firestore.googleapis.com/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes

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

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

مولفه های
parent

string

نام والد فرم projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

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

مولفه های
filter

string

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

pageSize

integer

تعداد نتایج برای بازگشت.

pageToken

string

یک نشانه صفحه، که از تماس قبلی با FirestoreAdmin.ListIndexes بازگردانده شده است، که ممکن است برای دریافت صفحه بعدی نتایج استفاده شود.

درخواست بدن

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

بدن پاسخگو

پاسخ برای FirestoreAdmin.ListIndexes .

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

نمایندگی JSON
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "nextPageToken": string
}
زمینه های
indexes[]

object ( Index )

شاخص های درخواستی

nextPageToken

string

نشانه صفحه ای که ممکن است برای درخواست صفحه دیگری از نتایج استفاده شود. اگر خالی باشد، این آخرین صفحه است.

محدوده مجوز

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

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

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