Enumera cada 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 estar obsoletos por unos segundos.
Utilice instances.get
para lecturas consistentes.
solicitud HTTP
GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances
La URL utiliza la sintaxis de transcodificación gRPC .
Parámetros de ruta
Parámetros | |
---|---|
parent | El proyecto principal para el cual enumerar las instancias de la base de datos, en el formato: Para enumerar todas las ubicaciones, utilice un padre en el formulario: La autorización requiere el siguiente permiso de IAM en el recurso
|
Parámetros de consulta
Parámetros | |
---|---|
pageToken | Token devuelto de una llamada anterior a |
pageSize | El número máximo de instancias de base de datos que se devolverán 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 | Indique que también se deben devolver las instancias de base de datos en estado |
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 ( |
Campos | |
---|---|
instances[] | Lista de cada |
nextPageToken | Si la lista de resultados es demasiado grande para caber en una sola respuesta, se devuelve un token. Si la cadena está vacía, entonces esta respuesta es la última página de resultados. Este token se puede utilizar en una llamada posterior a Los tokens de página son de corta duración y no deben persistir. |
Alcances 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 .