REST Resource: projects.locations.instances

Recurso: Instancia de base de datos

Representación de una instancia de Realtime Database. Los detalles sobre la interacción con el contenido de una instancia de base de datos se pueden encontrar en: https://firebase.google.com/docs/database/rest/start .

Representación JSON
{
  "name": string,
  "project": string,
  "databaseUrl": string,
  "type": enum (DatabaseInstanceType),
  "state": enum (State)
}
Campos
name

string

El nombre completo del recurso de la instancia de la base de datos, con el formato: projects/{project-number}/locations/{location-id}/instances/{database-id} .

project

string

Solo salida. El nombre del recurso del proyecto al que pertenece esta instancia. Por ejemplo: projects/{project-number} .

databaseUrl

string

Solo salida. Solo salida. El nombre de host globalmente único de la base de datos.

type

enum ( DatabaseInstanceType )

Inmutable. El tipo de instancia de la base de datos. En la creación, solo se permite USER_DATABASE, que también es el valor predeterminado cuando se omite.

state

enum ( State )

Solo salida. El estado del ciclo de vida de la base de datos. Solo lectura.

Tipo de instancia de base de datos

Los tipos posibles de una instancia de base de datos.

Enumeraciones
DATABASE_INSTANCE_TYPE_UNSPECIFIED Estado desconocido, probablemente como resultado de un error en el backend. Esto solo se usa para distinguir valores no establecidos.
DEFAULT_DATABASE La base de datos predeterminada que se aprovisiona cuando se crea un proyecto.
USER_DATABASE Una base de datos que el usuario creó.

Estado

Estados del ciclo de vida de la base de datos.

Enumeraciones
LIFECYCLE_STATE_UNSPECIFIED Estado no especificado, probablemente como resultado de un error en el backend. Esto solo se usa para distinguir valores no establecidos.
ACTIVE El estado normal y activo.
DISABLED La base de datos está en un estado deshabilitado. Se puede volver a habilitar más tarde.
DELETED La base de datos está en un estado eliminado.

Métodos

create

Solicita que se cree una nueva instancia de base de DatabaseInstance .

delete

Marca una instancia de base de DatabaseInstance para que se elimine.

disable

Deshabilita una instancia de base de DatabaseInstance .

get

Obtiene la instancia de base de DatabaseInstance identificada por el nombre de recurso especificado.

list

Enumera cada instancia de base de DatabaseInstance asociada con el proyecto principal especificado.

reenable

Habilita una instancia de base de DatabaseInstance .

undelete

Restaura una instancia de base de DatabaseInstance que se marcó previamente para ser eliminada.