REST Resource: projects.locations.instances

Ressource: DatabaseInstance

Darstellung einer Echtzeitdatenbankinstanz. Details zur Interaktion mit Inhalten einer DatabaseInstance finden Sie unter: https://firebase.google.com/docs/database/rest/start .

JSON-Darstellung
{
  "name": string,
  "project": string,
  "databaseUrl": string,
  "type": enum (DatabaseInstanceType),
  "state": enum (State)
}
Felder
name

string

Der vollständig qualifizierte Ressourcenname der Datenbankinstanz im Format: projects/{project-number}/locations/{location-id}/instances/{database-id} .

project

string

Nur Ausgabe. Der Ressourcenname des Projekts, zu dem diese Instanz gehört. Zum Beispiel: projects/{project-number} .

databaseUrl

string

Nur Ausgabe. Nur Ausgabe. Der weltweit eindeutige Hostname der Datenbank.

type

enum ( DatabaseInstanceType )

Unveränderlich. Der Datenbankinstanztyp. Bei der Erstellung ist nur USER_DATABASE zulässig, was auch die Standardeinstellung ist, wenn es weggelassen wird.

state

enum ( State )

Nur Ausgabe. Der Lebenszyklusstatus der Datenbank. Schreibgeschützt.

DatabaseInstanceType

Die möglichen Typen einer Datenbankinstanz.

Aufzählungen
DATABASE_INSTANCE_TYPE_UNSPECIFIED Unbekannter Status, wahrscheinlich das Ergebnis eines Fehlers im Backend. Dies wird nur zur Unterscheidung nicht gesetzter Werte verwendet.
DEFAULT_DATABASE Die Standarddatenbank, die bereitgestellt wird, wenn ein Projekt erstellt wird.
USER_DATABASE Eine Datenbank, die der Benutzer erstellt hat.

Zustand

Status des Datenbanklebenszyklus.

Aufzählungen
LIFECYCLE_STATE_UNSPECIFIED Nicht spezifizierter Zustand, wahrscheinlich das Ergebnis eines Fehlers im Backend. Dies wird nur zur Unterscheidung nicht gesetzter Werte verwendet.
ACTIVE Der normale und aktive Zustand.
DISABLED Die Datenbank befindet sich in einem deaktivierten Zustand. Es kann später wieder aktiviert werden.
DELETED Die Datenbank befindet sich in einem gelöschten Zustand.

Methoden

create

 Fordert die Erstellung einer neuen DatabaseInstance an.

delete

 Markiert eine zu löschende DatabaseInstance .

disable

 Deaktiviert eine DatabaseInstance .

get

 Ruft die DatabaseInstance ab, die durch den angegebenen Ressourcennamen identifiziert wird.

list

 Listet jede DatabaseInstance auf, die dem angegebenen übergeordneten Projekt zugeordnet ist.

reenable

 Aktiviert eine DatabaseInstance .

undelete

 Stellt eine DatabaseInstance wieder her, die zuvor zum Löschen markiert war.