Method: projects.locations.instances.list

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

Los elementos de la lista se devuelven sin ningún orden en particular, pero será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 .

Los resultados de la lista pueden quedar obsoletos por unos segundos.

Use instances.get para lecturas consistentes.

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
parent

string

El proyecto principal para el que enumerar las instancias de la base de datos, en el formato: projects/{project-number}/locations/{location-id}

Para enumerar todas las ubicaciones, use un padre en la forma: projects/{project-number}/locations/-

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

  • firebasedatabase.instances.list

Parámetros de consulta

Parámetros
pageToken

string

Token devuelto de una llamada anterior a instances.list que indica en qué parte del conjunto de instancias de la base de datos se reanuda la lista.

pageSize

integer

El número máximo de instancias de base de datos para devolver en la respuesta.

El servidor puede devolver menos que esto a su 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

Indique que también se deben devolver las instancias de base de datos en estado DELETED .

cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de respuesta

Si tiene éxito, 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 está en el proyecto principal de Firebase.

nextPageToken

string

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

Este token se puede usar en una llamada posterior 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 conservarse.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos 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, consulte Descripción general de la autenticación .