REST Resource: projects.locations.instances

Zasób: DatabaseInstance

Reprezentacja instancji bazy danych czasu rzeczywistego. Szczegółowe informacje o interakcji z zawartością instancji bazy danych znajdziesz na stronie https://firebase.google.com/docs/database/rest/start.

Zapis JSON
{
  "name": string,
  "project": string,
  "databaseUrl": string,
  "type": enum (DatabaseInstanceType),
  "state": enum (State)
}
Pola
name

string

Pełna nazwa zasobu instancji bazy danych w formacie: projects/{project-number}/locations/{location-id}/instances/{database-id}.

project

string

Tylko dane wyjściowe. Nazwa zasobu projektu, do którego należy ta instancja. Na przykład: projects/{project-number}.

databaseUrl

string

Tylko dane wyjściowe. Tylko dane wyjściowe. Globalnie unikalna nazwa hosta bazy danych.

type

enum (DatabaseInstanceType)

Stała. Typ instancji bazy danych. Dozwolone jest tylko tworzenie bazy danych USER_DATABASE, która jest też wartością domyślną w przypadku pominięcia.

state

enum (State)

Tylko dane wyjściowe. Stan cyklu życia bazy danych. Tylko do odczytu.

Typ instancji bazy danych

Możliwe typy instancji bazy danych.

Wartości w polu enum
DATABASE_INSTANCE_TYPE_UNSPECIFIED Stan nieznany, prawdopodobnie w wyniku błędu w backendzie. Służy ona tylko do rozróżniania wartości nieskonfigurowanych.
DEFAULT_DATABASE Domyślna baza danych, która jest udostępniana podczas tworzenia projektu.
USER_DATABASE Baza danych utworzona przez użytkownika.

Stan

Stany cyklu życia bazy danych.

Wartości w polu enum
LIFECYCLE_STATE_UNSPECIFIED Nieokreślony stan, prawdopodobnie w wyniku błędu w backendzie. Służy ona tylko do rozróżniania wartości nieskonfigurowanych.
ACTIVE Stan normalny i aktywny.
DISABLED Baza danych jest wyłączona. Możesz włączyć ją ponownie później.
DELETED Baza danych jest usunięta.

Metody

create

Żądania utworzenia nowego elementu DatabaseInstance.

delete

Oznacza element DatabaseInstance do usunięcia.

disable

Wyłącza obiekt DatabaseInstance.

get

Pobiera obiekt DatabaseInstance identyfikowany przez określoną nazwę zasobu.

list

Zawiera listę wszystkich elementów DatabaseInstance powiązanych z określonym projektem nadrzędnym.

reenable

Włącza: DatabaseInstance.

undelete

Przywraca element DatabaseInstance, który został wcześniej oznaczony do usunięcia.