REST Resource: projects.locations.instances

Ресурс: Экземпляр базы данных

Представление экземпляра базы данных реального времени. Подробности о взаимодействии с содержимым DatabaseInstance можно найти по адресу: https://firebase.google.com/docs/database/rest/start .

JSON-представление
{
  "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 )

Только вывод. Состояние жизненного цикла базы данных. Только для чтения.

Тип базы данныхInstanceType

Возможные типы экземпляра базы данных.

Перечисления
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 , который ранее был помечен для удаления.