Method: projects.locations.instances.list

Listet jede DatabaseInstance auf, die dem angegebenen übergeordneten Projekt zugeordnet ist.

Die Listenelemente werden in keiner bestimmten Reihenfolge zurückgegeben, stellen jedoch eine konsistente Ansicht der Datenbankinstanzen dar, wenn zusätzliche Anforderungen mit einem pageToken gestellt werden.

Die resultierende Liste enthält Instanzen in jedem STATE .

Die Listenergebnisse können einige Sekunden veraltet sein.

Verwenden Sie instances.get für konsistente Lesevorgänge.

HTTP-Anfrage

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

Die URL verwendet die gRPC-Transcoding -Syntax.

Pfadparameter

Parameter
parent

string

Das übergeordnete Projekt, für das Datenbankinstanzen aufgelistet werden sollen, im Format: projects/{project-number}/locations/{location-id}

Um alle Standorte aufzulisten, verwenden Sie ein übergeordnetes Element in der Form: projects/{project-number}/locations/-

Für die Autorisierung ist die folgende IAM- Berechtigung für die angegebene parent Ressource erforderlich:

  • firebasedatabase.instances.list

Abfrageparameter

Parameter
pageToken

string

Von einem vorherigen Aufruf von instances.list zurückgegebenes Token, das angibt, an welcher Stelle im Satz von Datenbankinstanzen die Auflistung fortgesetzt werden soll.

pageSize

integer

Die maximale Anzahl von Datenbankinstanzen, die in der Antwort zurückgegeben werden sollen.

Der Server kann nach eigenem Ermessen weniger zurückgeben. Wenn kein Wert angegeben wird (oder ein zu großer Wert angegeben wird), legt der Server sein eigenes Limit fest.

showDeleted

boolean

Geben Sie an, dass auch Datenbankinstanzen im DELETED Status zurückgegeben werden sollen.

Anforderungstext

Der Anfragetext muss leer sein.

Antwortkörper

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Die Antwort der Methode instances.list .

JSON-Darstellung
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
Felder
instances[]

object ( DatabaseInstance )

Liste aller DatabaseInstance , die sich im übergeordneten Firebase-Projekt befinden.

nextPageToken

string

Wenn die Ergebnisliste zu groß ist, um in eine einzelne Antwort zu passen, wird ein Token zurückgegeben. Wenn die Zeichenfolge leer ist, handelt es sich bei dieser Antwort um die letzte Ergebnisseite.

Dieses Token kann in einem nachfolgenden Aufruf von instances.list verwendet werden, um die nächste Gruppe von Datenbankinstanzen zu finden.

Seitentokens sind von kurzer Dauer und sollten nicht beibehalten werden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie in der Authentifizierungsübersicht .