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 .

تمثيل جيسون
{
  "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

لمزيد من المعلومات، راجع نظرة عامة على المصادقة .