Method: projects.locations.instances.list

هر DatabaseInstance مرتبط با پروژه والد مشخص شده را فهرست می کند.

موارد لیست بدون ترتیب خاصی برگردانده می شوند، اما زمانی که درخواست های اضافی با pageToken انجام می شود، نمای ثابتی از نمونه های پایگاه داده خواهد بود.

لیست حاصل شامل نمونه هایی در هر STATE است.

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

برای خواندن مداوم instances.get استفاده کنید.

درخواست HTTP

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

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

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

مولفه های
parent

string

پروژه والد که برای فهرست کردن نمونه های پایگاه داده، به شکل: projects/{project-number}/locations/{location-id}

برای فهرست کردن در همه مکان‌ها، از یک والد به این شکل استفاده کنید: projects/{project-number}/locations/-

مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد:

  • firebasedatabase.instances.list

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

مولفه های
pageToken

string

توکن از تماس قبلی به instances.list برگشت که نشان می‌دهد کجای مجموعه نمونه‌های پایگاه‌داده برای ازسرگیری فهرست قرار دارد.

pageSize

integer

حداکثر تعداد نمونه های پایگاه داده برای بازگشت در پاسخ.

سرور ممکن است به صلاحدید خود کمتر از این مقدار را برگرداند. اگر مقداری مشخص نشده باشد (یا مقدار بسیار بزرگی مشخص شده باشد)، سرور محدودیت خود را اعمال می کند.

showDeleted

boolean

نشان دهید که DatabaseInstances در حالت DELETED نیز باید برگردانده شوند.

درخواست بدن

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

بدن پاسخگو

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

پاسخ از روش instances.list .

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

object ( DatabaseInstance )

فهرست هر DatabaseInstance که در پروژه اصلی Firebase قرار دارد.

nextPageToken

string

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

این نشانه را می توان در فراخوانی بعدی به instances.list برای یافتن گروه بعدی نمونه های پایگاه داده استفاده کرد.

توکن های صفحه کوتاه مدت هستند و نباید ادامه پیدا کنند.

محدوده مجوز

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

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