REST Resource: projects.locations.instances

Recurso: DatabaseInstance

Representação de uma instância do Realtime Database. Detalhes sobre a interação com o conteúdo de um DatabaseInstance podem ser encontrados em: https://firebase.google.com/docs/database/rest/start.

Representação JSON
{
  "name": string,
  "project": string,
  "databaseUrl": string,
  "type": enum (DatabaseInstanceType),
  "state": enum (State)
}
Campos
name

string

O nome de recurso totalmente qualificado da instância do banco de dados, no formato: projects/{project-number}/locations/{location-id}/instances/{database-id}.

project

string

Apenas saída. O nome do recurso do projeto a que essa instância pertence. Por exemplo, projects/{project-number}.

databaseUrl

string

Apenas saída. Somente saída. O nome do host globalmente exclusivo do banco de dados.

type

enum (DatabaseInstanceType)

Imutável. O tipo de instância do banco de dados. Na criação, somente USER_DATABASE é permitido, que também é o padrão quando omitido.

state

enum (State)

Apenas saída. Estado do ciclo de vida do banco de dados. Somente leitura.

DatabaseInstanceType

Os tipos possíveis de uma instância de banco de dados.

Enums
DATABASE_INSTANCE_TYPE_UNSPECIFIED Estado desconhecido, provavelmente o resultado de um erro no back-end. Usado apenas para distinguir valores não definidos.
DEFAULT_DATABASE O banco de dados padrão provisionado quando um projeto é criado.
USER_DATABASE Um banco de dados criado pelo usuário.

Estado

estados do ciclo de vida do banco de dados.

Enums
LIFECYCLE_STATE_UNSPECIFIED Estado não especificado, provavelmente o resultado de um erro no back-end. Usado apenas para distinguir valores não definidos.
ACTIVE O estado normal e ativo.
DISABLED O banco de dados está desativado. Ele pode ser reativado mais tarde.
DELETED O banco de dados foi excluído.

Métodos

create

Solicita a criação de um novo DatabaseInstance.

delete

Marca um DatabaseInstance para ser excluído.

disable

Desativa um DatabaseInstance.

get

Recebe o DatabaseInstance identificado pelo nome do recurso especificado.

list

Lista cada DatabaseInstance associado ao projeto pai especificado.

reenable

Ativa um DatabaseInstance.

undelete

Restaura um DatabaseInstance que foi previamente marcado para exclusão.