REST Resource: projects.locations.instances

المصدر: DatabaseInstance

تمثيل مثيل قاعدة بيانات الوقت الحقيقي. يمكن العثور على تفاصيل حول التفاعل مع محتويات DatabaseInstance على: https://firebase.google.com/docs/database/rest/start .

تمثيل جيسون
{
  "name": string,
  "project": string,
  "databaseUrl": string,
  "type": enum (DatabaseInstanceType),
  "state": enum (State)
}
مجالات
name

string

اسم المورد المؤهل بالكامل لمثيل قاعدة البيانات، في النموذج: projects/{project-number}/locations/{location-id}/instances/{database-id} .

project

string

الإخراج فقط. اسم المورد للمشروع الذي ينتمي إليه هذا المثيل. على سبيل المثال: projects/{project-number} .

databaseUrl

string

الإخراج فقط. الإخراج فقط. اسم المضيف الفريد عالميًا لقاعدة البيانات.

type

enum ( DatabaseInstanceType )

غير قابل للتغيير. نوع مثيل قاعدة البيانات. عند الإنشاء، يُسمح فقط بـ USER_DATABASE، وهو أيضًا الإعداد الافتراضي عند حذفه.

state

enum ( State )

الإخراج فقط. حالة دورة حياة قاعدة البيانات. يقرأ فقط.

DatabaseInstanceType

الأنواع المحتملة لمثيل قاعدة البيانات.

التعدادات
DATABASE_INSTANCE_TYPE_UNSPECIFIED حالة غير معروفة، من المحتمل أن تكون نتيجة خطأ في الواجهة الخلفية. يستخدم هذا فقط للتمييز بين القيم غير المحددة.
DEFAULT_DATABASE قاعدة البيانات الافتراضية التي يتم توفيرها عند إنشاء المشروع.
USER_DATABASE قاعدة البيانات التي أنشأها المستخدم.

ولاية

حالات دورة حياة قاعدة البيانات.

التعدادات
LIFECYCLE_STATE_UNSPECIFIED حالة غير محددة، من المحتمل أن تكون نتيجة خطأ في الواجهة الخلفية. يستخدم هذا فقط للتمييز بين القيم غير المحددة.
ACTIVE الحالة الطبيعية والنشيطة.
DISABLED قاعدة البيانات في حالة تعطيل. ويمكن إعادة تمكينه لاحقًا.
DELETED قاعدة البيانات في حالة محذوفة.

طُرق

create

 يطلب إنشاء DatabaseInstance جديد.

delete

 يضع علامة على DatabaseInstance ليتم حذفه.

disable

 تعطيل مثيل DatabaseInstance .

get

 يحصل على DatabaseInstance المحدد بواسطة اسم المورد المحدد.

list

 يسرد كل DatabaseInstance المرتبط بالمشروع الأصلي المحدد.

reenable

 تمكين DatabaseInstance .

undelete

 يستعيد DatabaseInstance الذي تم وضع علامة عليه مسبقًا ليتم حذفه.