Method: projects.locations.instances.list

Wyświetla listę poszczególnych DatabaseInstance skojarzonych z określonym projektem nadrzędnym.

Elementy listy są zwracane w dowolnej kolejności, ale będą stanowić spójny widok instancji bazy danych, gdy zostaną wykonane dodatkowe żądania za pomocą pageToken .

Wynikowa lista zawiera instancje w dowolnym STATE .

Wyniki listy mogą być nieaktualne o kilka sekund.

Użyj instances.get , aby uzyskać spójne odczyty.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC .

Parametry ścieżki

Parametry
parent

string

Projekt nadrzędny, dla którego ma zostać wyświetlona lista instancji bazy danych, w postaci: projects/{project-number}/locations/{location-id}

Aby wyświetlić listę we wszystkich lokalizacjach, użyj elementu nadrzędnego w postaci: projects/{project-number}/locations/-

Autoryzacja wymaga następujących uprawnień dla określonego zasobu parent :

  • firebasedatabase.instances.list

Parametry zapytania

Parametry
pageToken

string

Token zwrócony z poprzedniego wywołania instances.list wskazujący, gdzie w zestawie instancji bazy danych należy wznowić wyświetlanie.

pageSize

integer

Maksymalna liczba instancji bazy danych zwracanych w odpowiedzi.

Serwer może według własnego uznania zwrócić mniejszą kwotę. Jeśli nie zostanie określona żadna wartość (lub zostanie określona wartość zbyt duża), serwer narzuci własny limit.

showDeleted

boolean

Wskaż, że powinny zostać zwrócone również DatabaseInstances w stanie DELETED .

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli się powiedzie, treść odpowiedzi zawiera dane o następującej strukturze:

Odpowiedź z metody instances.list .

Reprezentacja JSON
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
Pola
instances[]

object ( DatabaseInstance )

Lista każdej DatabaseInstance znajdującej się w nadrzędnym projekcie Firebase.

nextPageToken

string

Jeśli lista wyników jest zbyt duża, aby zmieścić się w jednej odpowiedzi, zwracany jest token. Jeśli ciąg jest pusty, ta odpowiedź jest ostatnią stroną wyników.

Token ten można wykorzystać w kolejnym wywołaniu instances.list w celu znalezienia kolejnej grupy instancji bazy danych.

Tokeny strony są krótkotrwałe i nie należy ich utrwalać.

Zakresy autoryzacji

Wymaga jednego z następujących zakresów 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

Aby uzyskać więcej informacji, zobacz Omówienie uwierzytelniania .