Method: projects.locations.instances.list

Muestra una lista de cada DatabaseInstance asociado con el proyecto superior especificado.

Los elementos de lista no se muestran siguiendo un orden específico, pero ofrecerán una vista coherente de las instancias de la base de datos cuando se realicen solicitudes adicionales con un pageToken.

La lista resultante contiene instancias en cualquier STATE.

Es posible que los resultados de la lista estén inactivos por unos segundos.

Usa instances.get para operaciones de lectura coherentes.

Solicitud HTTP

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

El proyecto superior para el que se enumeran las instancias de bases de datos, con el siguiente formato: projects/{project-number}/locations/{location-id}

Para mostrar una lista de todas las ubicaciones, usa un elemento superior con el formato: projects/{project-number}/locations/-

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • firebasedatabase.instances.list

Parámetros de consulta

Parámetros
pageToken

string

El token que se muestra desde una llamada anterior a instances.list que indica en qué lugar del conjunto de instancias de base de datos se puede reanudar la lista.
pageSize

integer

La cantidad máxima de instancias de base de datos que se mostrarán en la respuesta.

Es posible que el servidor muestre menos de este valor a discreción. Si no se especifica ningún valor (o se especifica un valor demasiado grande), el servidor impondrá su propio límite.
showDeleted

boolean

Indica que también se deberían mostrar DatabaseInstances en el estado DELETED.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

La respuesta del método instances.list

Representación JSON 
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
Campos
instances[]

object (DatabaseInstance)

Lista de cada DatabaseInstance que se encuentra en el proyecto principal de Firebase.
nextPageToken

string

Si la lista de resultados es demasiado grande para caber en una sola respuesta, entonces se muestra un token. Si la string está vacía, entonces la respuesta está en la última página de resultados.

Este token se puede usar en las llamadas posteriores a instances.list para encontrar el siguiente grupo de instancias de base de datos.

Los tokens de página son de corta duración y no deben ser persistentes.

Alcances con autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

Para obtener más información, consulta Descripción general de la autenticación.